Google Cloud Container V1 Client - Class StartIPRotationRequest (2.0.0)

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

StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP.

Generated from protobuf message google.container.v1.StartIPRotationRequest

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. This field has been deprecated and replaced by the name field.
`↳ name`	`string` The name (project, location, cluster name) of the cluster to start IP rotation. Specified in the format `projects//locations//clusters/*`.
`↳ rotate_credentials`	`bool` Whether to rotate credentials during IP rotation.

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.

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

Returns
Type	Description
`string`

setClusterId

Deprecated. The name of the cluster.

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getName

The name (project, location, cluster name) of the cluster to start IP rotation. Specified in the format projects/*/locations/*/clusters/*.

Returns
Type	Description
`string`

setName

The name (project, location, cluster name) of the cluster to start IP rotation. Specified in the format projects/*/locations/*/clusters/*.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRotateCredentials

Whether to rotate credentials during IP rotation.

Returns
Type	Description
`bool`

setRotateCredentials

Whether to rotate credentials during IP rotation.

Parameter
Name	Description
`var`	`bool`

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. This field has been deprecated and replaced by the name field.

Returns
Type	Description
`Google\Cloud\Container\V1\StartIPRotationRequest`

static::buildFromName

Parameter
Name	Description
`name`	`string` The name (project, location, cluster name) of the cluster to start IP rotation. Specified in the format `projects//locations//clusters/*`.

Returns
Type	Description
`Google\Cloud\Container\V1\StartIPRotationRequest`