Google Cloud Container V1 Client - Class UpdateClusterRequest (1.31.0)

Reference documentation and code samples for the Google Cloud Container V1 Client class UpdateClusterRequest.

UpdateClusterRequest updates the settings of a cluster.

Generated from protobuf message google.container.v1.UpdateClusterRequest

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.
↳ update Google\Cloud\Container\V1\ClusterUpdate

Required. A description of the update.
↳ name string

The name (project, location, cluster) of the cluster to update. 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

getUpdate

Required. A description of the update.

Returns
Type Description
Google\Cloud\Container\V1\ClusterUpdate|null

hasUpdate

clearUpdate

setUpdate

Required. A description of the update.

Parameter
Name Description
var Google\Cloud\Container\V1\ClusterUpdate
Returns
Type Description
$this

getName

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

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

Returns
Type Description
string

setName

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

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.
update Google\Cloud\Container\V1\ClusterUpdate

Required. A description of the update.
Returns
Type Description
Google\Cloud\Container\V1\UpdateClusterRequest

static::buildFromNameUpdate

Parameters
Name Description
name string

The name (project, location, cluster) of the cluster to update. Specified in the format projects/*/locations/*/clusters/*.
update Google\Cloud\Container\V1\ClusterUpdate

Required. A description of the update.
Returns
Type Description
Google\Cloud\Container\V1\UpdateClusterRequest