Reference documentation and code samples for the Google Anthos Multi Cloud V1 Client class CreateAttachedClusterRequest.
Request message for AttachedClusters.CreateAttachedCluster method.
Generated from protobuf message google.cloud.gkemulticloud.v1.CreateAttachedClusterRequest
Methods
build
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The parent location where this AttachedCluster resource will be created. Location names are formatted as See Resource Names for more details on Google Cloud resource names. Please see {@see \Google\Cloud\GkeMultiCloud\V1\AttachedClustersClient::locationName()} for help formatting this field. |
attachedCluster |
Google\Cloud\GkeMultiCloud\V1\AttachedCluster
Required. The specification of the AttachedCluster to create. |
attachedClusterId |
string
Required. A client provided ID the resource. Must be unique within the parent resource. The provided ID will be part of the
AttachedCluster resource
name formatted as
Valid characters are |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\CreateAttachedClusterRequest | |
__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 |
↳ attached_cluster |
Google\Cloud\GkeMultiCloud\V1\AttachedCluster
Required. The specification of the AttachedCluster to create. |
↳ attached_cluster_id |
string
Required. A client provided ID the resource. Must be unique within the parent resource. The provided ID will be part of the AttachedCluster resource name formatted as |
↳ validate_only |
bool
If set, only validate the request, but do not actually create the cluster. |
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 | |
getAttachedCluster
Required. The specification of the AttachedCluster to create.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\AttachedCluster|null | |
hasAttachedCluster
clearAttachedCluster
setAttachedCluster
Required. The specification of the AttachedCluster to create.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\AttachedCluster
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAttachedClusterId
Required. A client provided ID 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.
| Returns | |
|---|---|
| Type | Description |
string | |
setAttachedClusterId
Required. A client provided ID 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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getValidateOnly
If set, only validate the request, but do not actually create the cluster.
| Returns | |
|---|---|
| Type | Description |
bool | |
setValidateOnly
If set, only validate the request, but do not actually create the cluster.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |