Class: Google::Apis::GkehubV1alpha2::Membership

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



871
872
873
# File 'lib/google/apis/gkehub_v1alpha2/classes.rb', line 871

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

Instance Attribute Details

#authorityGoogle::Apis::GkehubV1alpha2::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



783
784
785
# File 'lib/google/apis/gkehub_v1alpha2/classes.rb', line 783

def authority
  @authority
end

#create_timeString

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

Returns:

  • (String)


788
789
790
# File 'lib/google/apis/gkehub_v1alpha2/classes.rb', line 788

def create_time
  @create_time
end

#delete_timeString

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

Returns:

  • (String)


793
794
795
# File 'lib/google/apis/gkehub_v1alpha2/classes.rb', line 793

def delete_time
  @delete_time
end

#descriptionString

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)


799
800
801
# File 'lib/google/apis/gkehub_v1alpha2/classes.rb', line 799

def description
  @description
end

#endpointGoogle::Apis::GkehubV1alpha2::MembershipEndpoint

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



805
806
807
# File 'lib/google/apis/gkehub_v1alpha2/classes.rb', line 805

def endpoint
  @endpoint
end

#external_idString

Optional. An externally-generated and managed ID for this Membership. This ID may be modified after creation, but this is not recommended. For GKE clusters, external_id is managed by the Hub API and updates will be ignored. 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)


815
816
817
# File 'lib/google/apis/gkehub_v1alpha2/classes.rb', line 815

def external_id
  @external_id
end

#infrastructure_typeString

Optional. The infrastructure type this Membership is running on. Corresponds to the JSON property infrastructureType

Returns:

  • (String)


820
821
822
# File 'lib/google/apis/gkehub_v1alpha2/classes.rb', line 820

def infrastructure_type
  @infrastructure_type
end

#labelsHash<String,String>

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

Returns:

  • (Hash<String,String>)


825
826
827
# File 'lib/google/apis/gkehub_v1alpha2/classes.rb', line 825

def labels
  @labels
end

#last_connection_timeString

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)


833
834
835
# File 'lib/google/apis/gkehub_v1alpha2/classes.rb', line 833

def last_connection_time
  @last_connection_time
end

#monitoring_configGoogle::Apis::GkehubV1alpha2::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



841
842
843
# File 'lib/google/apis/gkehub_v1alpha2/classes.rb', line 841

def monitoring_config
  @monitoring_config
end

#nameString

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)


852
853
854
# File 'lib/google/apis/gkehub_v1alpha2/classes.rb', line 852

def name
  @name
end

#stateGoogle::Apis::GkehubV1alpha2::MembershipState

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



857
858
859
# File 'lib/google/apis/gkehub_v1alpha2/classes.rb', line 857

def state
  @state
end

#unique_idString

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)


864
865
866
# File 'lib/google/apis/gkehub_v1alpha2/classes.rb', line 864

def unique_id
  @unique_id
end

#update_timeString

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

Returns:

  • (String)


869
870
871
# File 'lib/google/apis/gkehub_v1alpha2/classes.rb', line 869

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
# File 'lib/google/apis/gkehub_v1alpha2/classes.rb', line 876

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)
  @infrastructure_type = args[:infrastructure_type] if args.key?(:infrastructure_type)
  @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