Reference documentation and code samples for the Google Cloud Container V1 Client class SetLocationsRequest.
SetLocationsRequest sets the locations of the cluster.
Generated from protobuf message google.container.v1.SetLocationsRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ project_id |
string
Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field. |
↳ zone |
string
Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field. |
↳ cluster_id |
string
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. |
↳ locations |
array
Required. The desired list of Google Compute Engine zones in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone. |
↳ name |
string
The name (project, location, cluster) of the cluster to set locations. Specified in the format |
getProjectId
Deprecated. The Google Developers Console project ID or project number.
This field has been deprecated and replaced by the name field.
Generated from protobuf field string project_id = 1 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
string | |
setProjectId
Deprecated. The Google Developers Console project ID or project number.
This field has been deprecated and replaced by the name field.
Generated from protobuf field string project_id = 1 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getZone
Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
Generated from protobuf field string zone = 2 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
string | |
setZone
Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
Generated from protobuf field string zone = 2 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getClusterId
Deprecated. The name of the cluster to upgrade.
This field has been deprecated and replaced by the name field.
Generated from protobuf field string cluster_id = 3 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
string | |
setClusterId
Deprecated. The name of the cluster to upgrade.
This field has been deprecated and replaced by the name field.
Generated from protobuf field string cluster_id = 3 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLocations
Required. The desired list of Google Compute Engine zones in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed.
This list must always include the cluster's primary zone.
Generated from protobuf field repeated string locations = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setLocations
Required. The desired list of Google Compute Engine zones in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed.
This list must always include the cluster's primary zone.
Generated from protobuf field repeated string locations = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getName
The name (project, location, cluster) of the cluster to set locations.
Specified in the format projects/*/locations/*/clusters/*.
Generated from protobuf field string name = 6;
| Returns | |
|---|---|
| Type | Description |
string | |
setName
The name (project, location, cluster) of the cluster to set locations.
Specified in the format projects/*/locations/*/clusters/*.
Generated from protobuf field string name = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |