Class: Google::Apis::GkehubV1::Membership

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/gkehub_v1/classes.rb,
lib/google/apis/gkehub_v1/representations.rb,
lib/google/apis/gkehub_v1/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.



3799
3800
3801
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3799

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

Instance Attribute Details

#authority ⇒ Google::Apis::GkehubV1::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:



3718
3719
3720
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3718

def authority
  @authority
end

#create_time ⇒ String

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

Returns:

  • (String) 


3723
3724
3725
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3723

def create_time
  @create_time
end

#delete_time ⇒ String

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

Returns:

  • (String) 


3728
3729
3730
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3728

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) 


3734
3735
3736
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3734

def description
  @description
end

#endpoint ⇒ Google::Apis::GkehubV1::MembershipEndpoint

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

Returns:



3740
3741
3742
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3740

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) 


3748
3749
3750
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3748

def external_id
  @external_id
end

#labels ⇒ Hash<String,String>

Optional. Labels for this membership. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


3753
3754
3755
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3753

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) 


3761
3762
3763
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3761

def last_connection_time
  @last_connection_time
end

#monitoring_config ⇒ Google::Apis::GkehubV1::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:



3769
3770
3771
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3769

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) 


3780
3781
3782
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3780

def name
  @name
end

#state ⇒ Google::Apis::GkehubV1::MembershipState

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

Returns:



3785
3786
3787
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3785

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) 


3792
3793
3794
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3792

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) 


3797
3798
3799
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3797

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3804

def update!(**args)
  @authority = args[:authority] if args.key?(:authority)
  @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)
  @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