Google Cloud Container V1 Client - Class SetLocationsRequest (1.17.1)

Version 1.17.1

• 2.3.0 (latest)
• 2.2.1
• 2.1.0
• 2.0.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.3
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.1
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.1
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.1
• 1.12.1
• 1.10.3
• 1.9.1

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

Namespace

Google \ Cloud \ Container \ V1

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 projects/*/locations/*/clusters/*.

getProjectId

Deprecated. The Google Developers Console project ID or project number.

This field has been deprecated and replaced by the name field.

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.

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.

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.

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.

Returns
Type	Description
string

setClusterId

Deprecated. The name of the cluster to upgrade.

This field has been deprecated and replaced by the name field.

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.

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.

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/*.

Returns
Type	Description
string

setName

The name (project, location, cluster) of the cluster to set locations.

Specified in the format projects/*/locations/*/clusters/*.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameters
Name	Description
projectId	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.
clusterId	string Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
locations	string[] 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.

Returns
Type	Description
Google\Cloud\Container\V1\SetLocationsRequest

static::buildFromNameLocations

Parameters
Name	Description
name	string The name (project, location, cluster) of the cluster to set locations. Specified in the format projects/*/locations/*/clusters/*.
locations	string[] 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.

Returns
Type	Description
Google\Cloud\Container\V1\SetLocationsRequest