Google Cloud Container V1 Client - Class StartIPRotationRequest (1.14.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

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
string

setProjectId

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

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getClusterId

Deprecated. The name of the cluster.

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

Returns
TypeDescription
string

setClusterId

Deprecated. The name of the cluster.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getName

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

Returns
TypeDescription
string

setName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRotateCredentials

Whether to rotate credentials during IP rotation.

Returns
TypeDescription
bool

setRotateCredentials

Whether to rotate credentials during IP rotation.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
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
TypeDescription
Google\Cloud\Container\V1\StartIPRotationRequest

static::buildFromName

Parameter
NameDescription
name string

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

Returns
TypeDescription
Google\Cloud\Container\V1\StartIPRotationRequest