Class: Google::Apis::GkehubV1alpha::Membership

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/gkehub_v1alpha/classes.rb,
lib/google/apis/gkehub_v1alpha/representations.rb,
lib/google/apis/gkehub_v1alpha/representations.rb

Overview

Membership contains information about a member cluster.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Membership

Returns a new instance of Membership.



4503
4504
4505
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 4503

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#authority ⇒ Google::Apis::GkehubV1alpha::Authority

Authority encodes how Google will recognize identities from this Membership. See the workload identity documentation for more details: https://cloud.google. com/kubernetes-engine/docs/how-to/workload-identity Corresponds to the JSON property authority

Returns:



4410
4411
4412
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 4410

def authority
  @authority
end

#cluster_tier ⇒ String

Output only. The tier of the cluster. Corresponds to the JSON property clusterTier

Returns:

  • (String) 


4415
4416
4417
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 4415

def cluster_tier
  @cluster_tier
end

#create_time ⇒ String

Output only. When the Membership was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


4420
4421
4422
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 4420

def create_time
  @create_time
end

#delete_time ⇒ String

Output only. When the Membership was deleted. Corresponds to the JSON property deleteTime

Returns:

  • (String) 


4425
4426
4427
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 4425

def delete_time
  @delete_time
end

#description ⇒ String

Output only. Description of this membership, limited to 63 characters. Must match the regex: a-zA-Z0-9* This field is present for legacy purposes. Corresponds to the JSON property description

Returns:

  • (String) 


4431
4432
4433
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 4431

def description
  @description
end

#endpoint ⇒ Google::Apis::GkehubV1alpha::MembershipEndpoint

MembershipEndpoint contains information needed to contact a Kubernetes API, endpoint and any additional Kubernetes metadata. Corresponds to the JSON property endpoint

Returns:



4437
4438
4439
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 4437

def endpoint
  @endpoint
end

#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* If this Membership represents a Kubernetes cluster, this value should be set to the UID of the kube-system namespace object. Corresponds to the JSON property externalId

Returns:

  • (String) 


4445
4446
4447
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 4445

def external_id
  @external_id
end

#labels ⇒ Hash<String,String>

Optional. Labels for this membership. These labels are not leveraged by multi- cluster features, instead, we prefer cluster labels, which can be set on GKE cluster or other cluster types. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


4452
4453
4454
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 4452

def labels
  @labels
end

#last_connection_time ⇒ String

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. Corresponds to the JSON property lastConnectionTime

Returns:

  • (String) 


4460
4461
4462
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 4460

def last_connection_time
  @last_connection_time
end

#membership_type ⇒ String

Output only. The type of the membership. Corresponds to the JSON property membershipType

Returns:

  • (String) 


4465
4466
4467
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 4465

def membership_type
  @membership_type
end

#monitoring_config ⇒ Google::Apis::GkehubV1alpha::MonitoringConfig

MonitoringConfig informs Fleet-based applications/services/UIs how the metrics for the underlying cluster is reported to cloud monitoring services. It can be set from empty to non-empty, but can't be mutated directly to prevent accidentally breaking the constinousty of metrics. Corresponds to the JSON property monitoringConfig

Returns:



4473
4474
4475
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 4473

def monitoring_config
  @monitoring_config
end

#name ⇒ String

Output only. The full, unique name of this Membership resource in the format projects/*/locations/*/memberships/membership_id`, set during creation. membership_idmust 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?, with a maximum length of 63 characters. Corresponds to the JSON propertyname`

Returns:

  • (String) 


4484
4485
4486
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 4484

def name
  @name
end

#state ⇒ Google::Apis::GkehubV1alpha::MembershipState

MembershipState describes the state of a Membership resource. Corresponds to the JSON property state

Returns:



4489
4490
4491
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 4489

def state
  @state
end

#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. Corresponds to the JSON property uniqueId

Returns:

  • (String) 


4496
4497
4498
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 4496

def unique_id
  @unique_id
end

#update_time ⇒ String

Output only. When the Membership was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


4501
4502
4503
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 4501

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
 
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 4508

def update!(**args)
  @authority = args[:authority] if args.key?(:authority)
  @cluster_tier = args[:cluster_tier] if args.key?(:cluster_tier)
  @create_time = args[:create_time] if args.key?(:create_time)
  @delete_time = args[:delete_time] if args.key?(:delete_time)
  @description = args[:description] if args.key?(:description)
  @endpoint = args[:endpoint] if args.key?(:endpoint)
  @external_id = args[:external_id] if args.key?(:external_id)
  @labels = args[:labels] if args.key?(:labels)
  @last_connection_time = args[:last_connection_time] if args.key?(:last_connection_time)
  @membership_type = args[:membership_type] if args.key?(:membership_type)
  @monitoring_config = args[:monitoring_config] if args.key?(:monitoring_config)
  @name = args[:name] if args.key?(:name)
  @state = args[:state] if args.key?(:state)
  @unique_id = args[:unique_id] if args.key?(:unique_id)
  @update_time = args[:update_time] if args.key?(:update_time)
end