Class: Google::Cloud::GkeHub::V1beta1::Membership

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

Overview

Membership contains information about a member cluster.

Defined Under Namespace

Modules: InfrastructureType Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#authority ⇒ ::Google::Cloud::GkeHub::V1beta1::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:



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/cloud/gkehub/v1beta1/membership.rb', line 95

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

  # Specifies the infrastructure type of a Membership. Infrastructure type is
  # used by Hub to control infrastructure-specific behavior, including pricing.
  #
  # Each GKE distribution (on-GCP, on-Prem, on-X,...) will set this field
  # automatically, but Attached Clusters customers should specify a type
  # during registration.
  module InfrastructureType
    # No type was specified. Some Hub functionality may require a type be
    # specified, and will not support Memberships with this value.
    INFRASTRUCTURE_TYPE_UNSPECIFIED = 0

    # Private infrastructure that is owned or operated by customer. This
    # includes GKE distributions such as GKE-OnPrem and GKE-OnBareMetal.
    ON_PREM = 1

    # Public cloud infrastructure.
    MULTI_CLOUD = 2
  end
end

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

Returns Output only. When the Membership was created.

Returns:



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/cloud/gkehub/v1beta1/membership.rb', line 95

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

  # Specifies the infrastructure type of a Membership. Infrastructure type is
  # used by Hub to control infrastructure-specific behavior, including pricing.
  #
  # Each GKE distribution (on-GCP, on-Prem, on-X,...) will set this field
  # automatically, but Attached Clusters customers should specify a type
  # during registration.
  module InfrastructureType
    # No type was specified. Some Hub functionality may require a type be
    # specified, and will not support Memberships with this value.
    INFRASTRUCTURE_TYPE_UNSPECIFIED = 0

    # Private infrastructure that is owned or operated by customer. This
    # includes GKE distributions such as GKE-OnPrem and GKE-OnBareMetal.
    ON_PREM = 1

    # Public cloud infrastructure.
    MULTI_CLOUD = 2
  end
end

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

Returns Output only. When the Membership was deleted.

Returns:



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/cloud/gkehub/v1beta1/membership.rb', line 95

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

  # Specifies the infrastructure type of a Membership. Infrastructure type is
  # used by Hub to control infrastructure-specific behavior, including pricing.
  #
  # Each GKE distribution (on-GCP, on-Prem, on-X,...) will set this field
  # automatically, but Attached Clusters customers should specify a type
  # during registration.
  module InfrastructureType
    # No type was specified. Some Hub functionality may require a type be
    # specified, and will not support Memberships with this value.
    INFRASTRUCTURE_TYPE_UNSPECIFIED = 0

    # Private infrastructure that is owned or operated by customer. This
    # includes GKE distributions such as GKE-OnPrem and GKE-OnBareMetal.
    ON_PREM = 1

    # Public cloud infrastructure.
    MULTI_CLOUD = 2
  end
end

#description ⇒ ::String

Returns Optional. Description of this membership, limited to 63 characters. Must match the regex: [a-zA-Z0-9][a-zA-Z0-9_\-\.\ ]*.

Returns:

  • (::String) —

    Optional. Description of this membership, limited to 63 characters. Must match the regex: [a-zA-Z0-9][a-zA-Z0-9_\-\.\ ]*



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/cloud/gkehub/v1beta1/membership.rb', line 95

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

  # Specifies the infrastructure type of a Membership. Infrastructure type is
  # used by Hub to control infrastructure-specific behavior, including pricing.
  #
  # Each GKE distribution (on-GCP, on-Prem, on-X,...) will set this field
  # automatically, but Attached Clusters customers should specify a type
  # during registration.
  module InfrastructureType
    # No type was specified. Some Hub functionality may require a type be
    # specified, and will not support Memberships with this value.
    INFRASTRUCTURE_TYPE_UNSPECIFIED = 0

    # Private infrastructure that is owned or operated by customer. This
    # includes GKE distributions such as GKE-OnPrem and GKE-OnBareMetal.
    ON_PREM = 1

    # Public cloud infrastructure.
    MULTI_CLOUD = 2
  end
end

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

Returns Optional. Endpoint information to reach this member.

Returns:



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/cloud/gkehub/v1beta1/membership.rb', line 95

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

  # Specifies the infrastructure type of a Membership. Infrastructure type is
  # used by Hub to control infrastructure-specific behavior, including pricing.
  #
  # Each GKE distribution (on-GCP, on-Prem, on-X,...) will set this field
  # automatically, but Attached Clusters customers should specify a type
  # during registration.
  module InfrastructureType
    # No type was specified. Some Hub functionality may require a type be
    # specified, and will not support Memberships with this value.
    INFRASTRUCTURE_TYPE_UNSPECIFIED = 0

    # Private infrastructure that is owned or operated by customer. This
    # includes GKE distributions such as GKE-OnPrem and GKE-OnBareMetal.
    ON_PREM = 1

    # Public cloud infrastructure.
    MULTI_CLOUD = 2
  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. 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][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. 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][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.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/cloud/gkehub/v1beta1/membership.rb', line 95

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

  # Specifies the infrastructure type of a Membership. Infrastructure type is
  # used by Hub to control infrastructure-specific behavior, including pricing.
  #
  # Each GKE distribution (on-GCP, on-Prem, on-X,...) will set this field
  # automatically, but Attached Clusters customers should specify a type
  # during registration.
  module InfrastructureType
    # No type was specified. Some Hub functionality may require a type be
    # specified, and will not support Memberships with this value.
    INFRASTRUCTURE_TYPE_UNSPECIFIED = 0

    # Private infrastructure that is owned or operated by customer. This
    # includes GKE distributions such as GKE-OnPrem and GKE-OnBareMetal.
    ON_PREM = 1

    # Public cloud infrastructure.
    MULTI_CLOUD = 2
  end
end

#infrastructure_type ⇒ ::Google::Cloud::GkeHub::V1beta1::Membership::InfrastructureType

Returns Optional. The infrastructure type this Membership is running on.

Returns:



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/cloud/gkehub/v1beta1/membership.rb', line 95

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

  # Specifies the infrastructure type of a Membership. Infrastructure type is
  # used by Hub to control infrastructure-specific behavior, including pricing.
  #
  # Each GKE distribution (on-GCP, on-Prem, on-X,...) will set this field
  # automatically, but Attached Clusters customers should specify a type
  # during registration.
  module InfrastructureType
    # No type was specified. Some Hub functionality may require a type be
    # specified, and will not support Memberships with this value.
    INFRASTRUCTURE_TYPE_UNSPECIFIED = 0

    # Private infrastructure that is owned or operated by customer. This
    # includes GKE distributions such as GKE-OnPrem and GKE-OnBareMetal.
    ON_PREM = 1

    # Public cloud infrastructure.
    MULTI_CLOUD = 2
  end
end

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

Returns Optional. GCP labels for this membership.

Returns:

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

    Optional. GCP labels for this membership.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/cloud/gkehub/v1beta1/membership.rb', line 95

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

  # Specifies the infrastructure type of a Membership. Infrastructure type is
  # used by Hub to control infrastructure-specific behavior, including pricing.
  #
  # Each GKE distribution (on-GCP, on-Prem, on-X,...) will set this field
  # automatically, but Attached Clusters customers should specify a type
  # during registration.
  module InfrastructureType
    # No type was specified. Some Hub functionality may require a type be
    # specified, and will not support Memberships with this value.
    INFRASTRUCTURE_TYPE_UNSPECIFIED = 0

    # Private infrastructure that is owned or operated by customer. This
    # includes GKE distributions such as GKE-OnPrem and GKE-OnBareMetal.
    ON_PREM = 1

    # Public cloud infrastructure.
    MULTI_CLOUD = 2
  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.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/cloud/gkehub/v1beta1/membership.rb', line 95

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

  # Specifies the infrastructure type of a Membership. Infrastructure type is
  # used by Hub to control infrastructure-specific behavior, including pricing.
  #
  # Each GKE distribution (on-GCP, on-Prem, on-X,...) will set this field
  # automatically, but Attached Clusters customers should specify a type
  # during registration.
  module InfrastructureType
    # No type was specified. Some Hub functionality may require a type be
    # specified, and will not support Memberships with this value.
    INFRASTRUCTURE_TYPE_UNSPECIFIED = 0

    # Private infrastructure that is owned or operated by customer. This
    # includes GKE distributions such as GKE-OnPrem and GKE-OnBareMetal.
    ON_PREM = 1

    # Public cloud infrastructure.
    MULTI_CLOUD = 2
  end
end

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

Returns Optional. The monitoring config information for this membership.

Returns:



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/cloud/gkehub/v1beta1/membership.rb', line 95

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

  # Specifies the infrastructure type of a Membership. Infrastructure type is
  # used by Hub to control infrastructure-specific behavior, including pricing.
  #
  # Each GKE distribution (on-GCP, on-Prem, on-X,...) will set this field
  # automatically, but Attached Clusters customers should specify a type
  # during registration.
  module InfrastructureType
    # No type was specified. Some Hub functionality may require a type be
    # specified, and will not support Memberships with this value.
    INFRASTRUCTURE_TYPE_UNSPECIFIED = 0

    # Private infrastructure that is owned or operated by customer. This
    # includes GKE distributions such as GKE-OnPrem and GKE-OnBareMetal.
    ON_PREM = 1

    # Public cloud infrastructure.
    MULTI_CLOUD = 2
  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.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/cloud/gkehub/v1beta1/membership.rb', line 95

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

  # Specifies the infrastructure type of a Membership. Infrastructure type is
  # used by Hub to control infrastructure-specific behavior, including pricing.
  #
  # Each GKE distribution (on-GCP, on-Prem, on-X,...) will set this field
  # automatically, but Attached Clusters customers should specify a type
  # during registration.
  module InfrastructureType
    # No type was specified. Some Hub functionality may require a type be
    # specified, and will not support Memberships with this value.
    INFRASTRUCTURE_TYPE_UNSPECIFIED = 0

    # Private infrastructure that is owned or operated by customer. This
    # includes GKE distributions such as GKE-OnPrem and GKE-OnBareMetal.
    ON_PREM = 1

    # Public cloud infrastructure.
    MULTI_CLOUD = 2
  end
end

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

Returns Output only. State of the Membership resource.

Returns:



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/cloud/gkehub/v1beta1/membership.rb', line 95

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

  # Specifies the infrastructure type of a Membership. Infrastructure type is
  # used by Hub to control infrastructure-specific behavior, including pricing.
  #
  # Each GKE distribution (on-GCP, on-Prem, on-X,...) will set this field
  # automatically, but Attached Clusters customers should specify a type
  # during registration.
  module InfrastructureType
    # No type was specified. Some Hub functionality may require a type be
    # specified, and will not support Memberships with this value.
    INFRASTRUCTURE_TYPE_UNSPECIFIED = 0

    # Private infrastructure that is owned or operated by customer. This
    # includes GKE distributions such as GKE-OnPrem and GKE-OnBareMetal.
    ON_PREM = 1

    # Public cloud infrastructure.
    MULTI_CLOUD = 2
  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.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/cloud/gkehub/v1beta1/membership.rb', line 95

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

  # Specifies the infrastructure type of a Membership. Infrastructure type is
  # used by Hub to control infrastructure-specific behavior, including pricing.
  #
  # Each GKE distribution (on-GCP, on-Prem, on-X,...) will set this field
  # automatically, but Attached Clusters customers should specify a type
  # during registration.
  module InfrastructureType
    # No type was specified. Some Hub functionality may require a type be
    # specified, and will not support Memberships with this value.
    INFRASTRUCTURE_TYPE_UNSPECIFIED = 0

    # Private infrastructure that is owned or operated by customer. This
    # includes GKE distributions such as GKE-OnPrem and GKE-OnBareMetal.
    ON_PREM = 1

    # Public cloud infrastructure.
    MULTI_CLOUD = 2
  end
end

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

Returns Output only. When the Membership was last updated.

Returns:



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/cloud/gkehub/v1beta1/membership.rb', line 95

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

  # Specifies the infrastructure type of a Membership. Infrastructure type is
  # used by Hub to control infrastructure-specific behavior, including pricing.
  #
  # Each GKE distribution (on-GCP, on-Prem, on-X,...) will set this field
  # automatically, but Attached Clusters customers should specify a type
  # during registration.
  module InfrastructureType
    # No type was specified. Some Hub functionality may require a type be
    # specified, and will not support Memberships with this value.
    INFRASTRUCTURE_TYPE_UNSPECIFIED = 0

    # Private infrastructure that is owned or operated by customer. This
    # includes GKE distributions such as GKE-OnPrem and GKE-OnBareMetal.
    ON_PREM = 1

    # Public cloud infrastructure.
    MULTI_CLOUD = 2
  end
end