Google Cloud Gke Hub V1 Client - Class Membership (1.0.0-RC1)

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

Membership contains information about a member cluster.

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

Namespace

Google \ Cloud \ GkeHub \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ endpoint Google\Cloud\GkeHub\V1\MembershipEndpoint

Optional. Endpoint information to reach this member.
↳ name string

Output only. The full, unique name of this Membership resource in the format projects/*/locations/*/memberships/{membership_id}, set during creation. membership_id must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or - 3. It must start and end with an alphanumeric character Which can be expressed as the regex: [a-z0-9]([-a-z0-9]*[a-z0-9])?, with a maximum length of 63 characters.
↳ labels array|Google\Protobuf\Internal\MapField

Optional. Labels for this membership.
↳ description string

Output only. Description of this membership, limited to 63 characters. Must match the regex: [a-zA-Z0-9][a-zA-Z0-9_\-\.\ ]* This field is present for legacy purposes.
↳ state Google\Cloud\GkeHub\V1\MembershipState

Output only. State of the Membership resource.
↳ create_time Google\Protobuf\Timestamp

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

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

Output only. When the Membership was deleted.
↳ external_id string

Optional. An externally-generated and managed ID for this Membership. This ID may be modified after creation, but this is not recommended. The ID must match the regex: [a-zA-Z0-9][a-zA-Z0-9_\-\.]* If this Membership represents a Kubernetes cluster, this value should be set to the UID of the kube-system namespace object.
↳ last_connection_time Google\Protobuf\Timestamp

Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset.
↳ unique_id string

Output only. Google-generated UUID for this resource. This is unique across all Membership resources. If a Membership resource is deleted and another resource with the same name is created, it gets a different unique_id.
↳ authority Google\Cloud\GkeHub\V1\Authority

Optional. How to identify workloads from this Membership. See the documentation on Workload Identity for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity
↳ monitoring_config Google\Cloud\GkeHub\V1\MonitoringConfig

Optional. The monitoring config information for this membership.

getEndpoint

Optional. Endpoint information to reach this member.

Returns
Type Description
Google\Cloud\GkeHub\V1\MembershipEndpoint|null

hasEndpoint

setEndpoint

Optional. Endpoint information to reach this member.

Parameter
Name Description
var Google\Cloud\GkeHub\V1\MembershipEndpoint
Returns
Type Description
$this

getName

Output only. The full, unique name of this Membership resource in the format projects/*/locations/*/memberships/{membership_id}, set during creation.

membership_id must be a valid RFC 1123 compliant DNS label:

  1. At most 63 characters in length
  2. It must consist of lower case alphanumeric characters or -
  3. It must start and end with an alphanumeric character Which can be expressed as the regex: [a-z0-9]([-a-z0-9]*[a-z0-9])?, with a maximum length of 63 characters.
Returns
Type Description
string

setName

Output only. The full, unique name of this Membership resource in the format projects/*/locations/*/memberships/{membership_id}, set during creation.

membership_id must be a valid RFC 1123 compliant DNS label:

  1. At most 63 characters in length
  2. It must consist of lower case alphanumeric characters or -
  3. It must start and end with an alphanumeric character Which can be expressed as the regex: [a-z0-9]([-a-z0-9]*[a-z0-9])?, with a maximum length of 63 characters.
Parameter
Name Description
var string
Returns
Type Description
$this

getLabels

Optional. Labels for this membership.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Optional. Labels for this membership.

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

getDescription

Output only. Description of this membership, limited to 63 characters.

Must match the regex: [a-zA-Z0-9][a-zA-Z0-9_\-\.\ ]* This field is present for legacy purposes.

Returns
Type Description
string

setDescription

Output only. Description of this membership, limited to 63 characters.

Must match the regex: [a-zA-Z0-9][a-zA-Z0-9_\-\.\ ]* This field is present for legacy purposes.

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Output only. State of the Membership resource.

Returns
Type Description
Google\Cloud\GkeHub\V1\MembershipState|null

hasState

clearState

setState

Output only. State of the Membership resource.

Parameter
Name Description
var Google\Cloud\GkeHub\V1\MembershipState
Returns
Type Description
$this

getCreateTime

Output only. When the Membership was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. When the Membership was created.

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

getUpdateTime

Output only. When the Membership was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. When the Membership was last updated.

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

getDeleteTime

Output only. When the Membership was deleted.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasDeleteTime

clearDeleteTime

setDeleteTime

Output only. When the Membership was deleted.

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

getExternalId

Optional. An externally-generated and managed ID for this Membership. This ID may be modified after creation, but this is not recommended.

The ID must match the regex: [a-zA-Z0-9][a-zA-Z0-9_\-\.]* If this Membership represents a Kubernetes cluster, this value should be set to the UID of the kube-system namespace object.

Returns
Type Description
string

setExternalId

Optional. An externally-generated and managed ID for this Membership. This ID may be modified after creation, but this is not recommended.

The ID must match the regex: [a-zA-Z0-9][a-zA-Z0-9_\-\.]* If this Membership represents a Kubernetes cluster, this value should be set to the UID of the kube-system namespace object.

Parameter
Name Description
var string
Returns
Type Description
$this

getLastConnectionTime

Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasLastConnectionTime

clearLastConnectionTime

setLastConnectionTime

Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset.

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

getUniqueId

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

Returns
Type Description
string

setUniqueId

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

Parameter
Name Description
var string
Returns
Type Description
$this

getAuthority

Optional. How to identify workloads from this Membership.

See the documentation on Workload Identity for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity

Returns
Type Description
Google\Cloud\GkeHub\V1\Authority|null

hasAuthority

clearAuthority

setAuthority

Optional. How to identify workloads from this Membership.

See the documentation on Workload Identity for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity

Parameter
Name Description
var Google\Cloud\GkeHub\V1\Authority
Returns
Type Description
$this

getMonitoringConfig

Optional. The monitoring config information for this membership.

Returns
Type Description
Google\Cloud\GkeHub\V1\MonitoringConfig|null

hasMonitoringConfig

clearMonitoringConfig

setMonitoringConfig

Optional. The monitoring config information for this membership.

Parameter
Name Description
var Google\Cloud\GkeHub\V1\MonitoringConfig
Returns
Type Description
$this

getType

Returns
Type Description
string