Google Anthos Multi Cloud V1 Client - Class GenerateAttachedClusterInstallManifestRequest (0.5.4)

Reference documentation and code samples for the Google Anthos Multi Cloud V1 Client class GenerateAttachedClusterInstallManifestRequest.

Request message for AttachedClusters.GenerateAttachedClusterInstallManifest method.

Generated from protobuf message google.cloud.gkemulticloud.v1.GenerateAttachedClusterInstallManifestRequest

Namespace

Google \ Cloud \ GkeMultiCloud \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The parent location where this AttachedCluster resource will be created. Location names are formatted as projects/<project-id>/locations/<region>. See Resource Names for more details on Google Cloud resource names.
↳ attached_cluster_id string

Required. A client provided ID of the resource. Must be unique within the parent resource. The provided ID will be part of the AttachedCluster resource name formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>. Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters. When generating an install manifest for importing an existing Membership resource, the attached_cluster_id field must be the Membership id. Membership names are formatted as projects/<project-id>/locations/<region>/memberships/<membership-id>.
↳ platform_version string

Required. The platform version for the cluster (e.g. 1.19.0-gke.1000). You can list all supported versions on a given Google Cloud region by calling GetAttachedServerConfig.
↳ proxy_config Google\Cloud\GkeMultiCloud\V1\AttachedProxyConfig

Optional. Proxy configuration for outbound HTTP(S) traffic.

getParent

Required. The parent location where this AttachedCluster resource will be created.

Location names are formatted as projects/<project-id>/locations/<region>. See Resource Names for more details on Google Cloud resource names.

Returns
Type Description
string

setParent

Required. The parent location where this AttachedCluster resource will be created.

Location names are formatted as projects/<project-id>/locations/<region>. See Resource Names for more details on Google Cloud resource names.

Parameter
Name Description
var string
Returns
Type Description
$this

getAttachedClusterId

Required. A client provided ID of the resource. Must be unique within the parent resource.

The provided ID will be part of the AttachedCluster resource name formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>. Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters. When generating an install manifest for importing an existing Membership resource, the attached_cluster_id field must be the Membership id. Membership names are formatted as projects/<project-id>/locations/<region>/memberships/<membership-id>.

Returns
Type Description
string

setAttachedClusterId

Required. A client provided ID of the resource. Must be unique within the parent resource.

The provided ID will be part of the AttachedCluster resource name formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>. Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters. When generating an install manifest for importing an existing Membership resource, the attached_cluster_id field must be the Membership id. Membership names are formatted as projects/<project-id>/locations/<region>/memberships/<membership-id>.

Parameter
Name Description
var string
Returns
Type Description
$this

getPlatformVersion

Required. The platform version for the cluster (e.g. 1.19.0-gke.1000).

You can list all supported versions on a given Google Cloud region by calling GetAttachedServerConfig.

Returns
Type Description
string

setPlatformVersion

Required. The platform version for the cluster (e.g. 1.19.0-gke.1000).

You can list all supported versions on a given Google Cloud region by calling GetAttachedServerConfig.

Parameter
Name Description
var string
Returns
Type Description
$this

getProxyConfig

Optional. Proxy configuration for outbound HTTP(S) traffic.

Returns
Type Description
Google\Cloud\GkeMultiCloud\V1\AttachedProxyConfig|null

hasProxyConfig

clearProxyConfig

setProxyConfig

Optional. Proxy configuration for outbound HTTP(S) traffic.

Parameter
Name Description
var Google\Cloud\GkeMultiCloud\V1\AttachedProxyConfig
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The parent location where this AttachedCluster resource will be created.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud resource names. Please see Google\Cloud\GkeMultiCloud\V1\AttachedClustersClient::locationName() for help formatting this field.
attachedClusterId string

Required. A client provided ID of the resource. Must be unique within the parent resource.

The provided ID will be part of the AttachedCluster resource name formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters.

When generating an install manifest for importing an existing Membership resource, the attached_cluster_id field must be the Membership id.

Membership names are formatted as projects/<project-id>/locations/<region>/memberships/<membership-id>.
Returns
Type Description
Google\Cloud\GkeMultiCloud\V1\GenerateAttachedClusterInstallManifestRequest