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

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

Fleet contains the Fleet-wide metadata and configuration.

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

Namespace

Google \ Cloud \ GkeHub \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Output only. The full, unique resource name of this fleet in the format of projects/{project}/locations/{location}/fleets/{fleet}. Each Google Cloud project can have at most one fleet resource, named "default".

↳ display_name string

Optional. A user-assigned display name of the Fleet. When present, it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: Production Fleet

↳ create_time Google\Protobuf\Timestamp

Output only. When the Fleet was created.

↳ update_time Google\Protobuf\Timestamp

Output only. When the Fleet was last updated.

↳ delete_time Google\Protobuf\Timestamp

Output only. When the Fleet was deleted.

↳ uid string

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

↳ state FleetLifecycleState

Output only. State of the namespace resource.

↳ default_cluster_config DefaultClusterConfig

Optional. The default cluster configurations to apply across the fleet.

↳ labels array|Google\Protobuf\Internal\MapField

Optional. Labels for this Fleet.

getName

Output only. The full, unique resource name of this fleet in the format of projects/{project}/locations/{location}/fleets/{fleet}.

Each Google Cloud project can have at most one fleet resource, named "default".

Returns
Type Description
string

setName

Output only. The full, unique resource name of this fleet in the format of projects/{project}/locations/{location}/fleets/{fleet}.

Each Google Cloud project can have at most one fleet resource, named "default".

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Optional. A user-assigned display name of the Fleet.

When present, it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: Production Fleet

Returns
Type Description
string

setDisplayName

Optional. A user-assigned display name of the Fleet.

When present, it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: Production Fleet

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. When the Fleet was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. When the Fleet was created.

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

getUpdateTime

Output only. When the Fleet was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. When the Fleet was last updated.

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

getDeleteTime

Output only. When the Fleet was deleted.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasDeleteTime

clearDeleteTime

setDeleteTime

Output only. When the Fleet was deleted.

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

getUid

Output only. Google-generated UUID for this resource. This is unique across all Fleet resources. If a Fleet 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 Fleet resources. If a Fleet 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

getState

Output only. State of the namespace resource.

Returns
Type Description
FleetLifecycleState|null

hasState

clearState

setState

Output only. State of the namespace resource.

Parameter
Name Description
var FleetLifecycleState
Returns
Type Description
$this

getDefaultClusterConfig

Optional. The default cluster configurations to apply across the fleet.

Returns
Type Description
DefaultClusterConfig|null

hasDefaultClusterConfig

clearDefaultClusterConfig

setDefaultClusterConfig

Optional. The default cluster configurations to apply across the fleet.

Parameter
Name Description
var DefaultClusterConfig
Returns
Type Description
$this

getLabels

Optional. Labels for this Fleet.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Optional. Labels for this Fleet.

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