Google Cloud Gke Hub V1 Client - Class Scope (1.3.0)

Reference documentation and code samples for the Google Cloud Gke Hub V1 Client class Scope.

Scope represents a Scope in a Fleet.

Generated from protobuf message google.cloud.gkehub.v1.Scope

Namespace

Google \ Cloud \ GkeHub \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

The resource name for the scope projects/{project}/locations/{location}/scopes/{scope}
↳ uid string

Output only. Google-generated UUID for this resource. This is unique across all scope resources. If a scope resource is deleted and another resource with the same name is created, it gets a different uid.
↳ create_time Google\Protobuf\Timestamp

Output only. When the scope was created.
↳ update_time Google\Protobuf\Timestamp

Output only. When the scope was last updated.
↳ delete_time Google\Protobuf\Timestamp

Output only. When the scope was deleted.
↳ state ScopeLifecycleState

Output only. State of the scope resource.
↳ namespace_labels array|Google\Protobuf\Internal\MapField

Optional. Scope-level cluster namespace labels. For the member clusters bound to the Scope, these labels are applied to each namespace under the Scope. Scope-level labels take precedence over Namespace-level labels (namespace_labels in the Fleet Namespace resource) if they share a key. Keys and values must be Kubernetes-conformant.
↳ labels array|Google\Protobuf\Internal\MapField

Optional. Labels for this Scope.

getName

The resource name for the scope projects/{project}/locations/{location}/scopes/{scope}

Returns
Type Description
string

setName

The resource name for the scope projects/{project}/locations/{location}/scopes/{scope}

Parameter
Name Description
var string
Returns
Type Description
$this

getUid

Output only. Google-generated UUID for this resource. This is unique across all scope resources. If a scope resource is deleted and another resource with the same name is created, it gets a different uid.

Returns
Type Description
string

setUid

Output only. Google-generated UUID for this resource. This is unique across all scope resources. If a scope resource is deleted and another resource with the same name is created, it gets a different uid.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. When the scope was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. When the scope was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. When the scope was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. When the scope was last updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getDeleteTime

Output only. When the scope was deleted.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasDeleteTime

clearDeleteTime

setDeleteTime

Output only. When the scope was deleted.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getState

Output only. State of the scope resource.

Returns
Type Description
ScopeLifecycleState|null

hasState

clearState

setState

Output only. State of the scope resource.

Parameter
Name Description
var ScopeLifecycleState
Returns
Type Description
$this

getNamespaceLabels

Optional. Scope-level cluster namespace labels. For the member clusters bound to the Scope, these labels are applied to each namespace under the Scope. Scope-level labels take precedence over Namespace-level labels (namespace_labels in the Fleet Namespace resource) if they share a key. Keys and values must be Kubernetes-conformant.

Returns
Type Description
Google\Protobuf\Internal\MapField

setNamespaceLabels

Optional. Scope-level cluster namespace labels. For the member clusters bound to the Scope, these labels are applied to each namespace under the Scope. Scope-level labels take precedence over Namespace-level labels (namespace_labels in the Fleet Namespace resource) if they share a key. Keys and values must be Kubernetes-conformant.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getLabels

Optional. Labels for this Scope.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Optional. Labels for this Scope.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this