Google Cloud Container V1 Client - Class SetLabelsRequest (1.9.1)

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

SetLabelsRequest sets the Google Cloud Platform labels on a Google Container Engine cluster, which will in turn set them for Google Compute Engine resources used by that cluster

Generated from protobuf message google.container.v1.SetLabelsRequest

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.

↳ resource_labels array|Google\Protobuf\Internal\MapField

Required. The labels to set for that cluster.

↳ label_fingerprint string

Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a get() request to the resource to get the latest fingerprint.

↳ name string

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

Generated from protobuf field string project_id = 1 [deprecated = true];

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.

Generated from protobuf field string project_id = 1 [deprecated = true];

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.

Generated from protobuf field string zone = 2 [deprecated = true];

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.

Generated from protobuf field string zone = 2 [deprecated = true];

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.

Generated from protobuf field string cluster_id = 3 [deprecated = true];

Returns
TypeDescription
string

setClusterId

Deprecated. The name of the cluster.

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

Generated from protobuf field string cluster_id = 3 [deprecated = true];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getResourceLabels

Required. The labels to set for that cluster.

Generated from protobuf field map<string, string> resource_labels = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setResourceLabels

Required. The labels to set for that cluster.

Generated from protobuf field map<string, string> resource_labels = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getLabelFingerprint

Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a get() request to the resource to get the latest fingerprint.

Generated from protobuf field string label_fingerprint = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
string

setLabelFingerprint

Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a get() request to the resource to get the latest fingerprint.

Generated from protobuf field string label_fingerprint = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getName

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

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

Generated from protobuf field string name = 7;

Returns
TypeDescription
string

setName

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

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

Generated from protobuf field string name = 7;

Parameter
NameDescription
var string
Returns
TypeDescription
$this