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.



3236
3237
3238
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3236

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:



3155
3156
3157
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3155

def authority
  @authority
end

#create_time ⇒ String

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

Returns:

  • (String) 


3160
3161
3162
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3160

def create_time
  @create_time
end

#delete_time ⇒ String

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

Returns:

  • (String) 


3165
3166
3167
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3165

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) 


3171
3172
3173
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3171

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:



3177
3178
3179
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3177

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) 


3185
3186
3187
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3185

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>) 


3190
3191
3192
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3190

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) 


3198
3199
3200
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3198

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:



3206
3207
3208
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3206

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) 


3217
3218
3219
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3217

def name
  @name
end

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

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

Returns:



3222
3223
3224
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3222

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) 


3229
3230
3231
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3229

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) 


3234
3235
3236
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3234

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3241

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