Class: Google::Cloud::GkeHub::V1::Membership

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/gkehub/v1/membership.rb

Overview

Membership contains information about a member cluster.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#authority ⇒ ::Google::Cloud::GkeHub::V1::Authority

Returns 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:



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/gkehub/v1/membership.rb', line 92

class Membership
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. When the Membership was created.

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/gkehub/v1/membership.rb', line 92

class Membership
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#delete_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. When the Membership was deleted.

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/gkehub/v1/membership.rb', line 92

class Membership
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#description ⇒ ::String (readonly)

Returns 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:

  • (::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.



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/gkehub/v1/membership.rb', line 92

class Membership
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#endpoint ⇒ ::Google::Cloud::GkeHub::V1::MembershipEndpoint

Returns Optional. Endpoint information to reach this member.

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/gkehub/v1/membership.rb', line 92

class Membership
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#external_id ⇒ ::String

Returns 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:

  • (::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.



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/gkehub/v1/membership.rb', line 92

class Membership
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. Labels for this membership.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. Labels for this membership.



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/gkehub/v1/membership.rb', line 92

class Membership
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#last_connection_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns 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:

  • (::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.



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/gkehub/v1/membership.rb', line 92

class Membership
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#monitoring_config ⇒ ::Google::Cloud::GkeHub::V1::MonitoringConfig

Returns Optional. The monitoring config information for this membership.

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/gkehub/v1/membership.rb', line 92

class Membership
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String (readonly)

Returns 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:

  • (::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.



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/gkehub/v1/membership.rb', line 92

class Membership
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#state ⇒ ::Google::Cloud::GkeHub::V1::MembershipState (readonly)

Returns Output only. State of the Membership resource.

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/gkehub/v1/membership.rb', line 92

class Membership
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#unique_id ⇒ ::String (readonly)

Returns 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:

  • (::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.



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/gkehub/v1/membership.rb', line 92

class Membership
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. When the Membership was last updated.

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/gkehub/v1/membership.rb', line 92

class Membership
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end