Reference documentation and code samples for the GKE Hub V1beta1 API class Google::Cloud::GkeHub::V1beta1::GkeHubMembershipService::Client.
Client for the GkeHubMembershipService service.
The GKE Hub MembershipService handles the registration of many Kubernetes clusters to Google Cloud, represented with the Membership resource.
GKE Hub is currently only available in the global region.
Membership management may be non-trivial: it is recommended to use one of the Google-provided client libraries or tools where possible when working with Membership resources.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the GkeHubMembershipService Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all GkeHubMembershipService clients ::Google::Cloud::GkeHub::V1beta1::GkeHubMembershipService::Client.configure do |config| config.timeout = 10.0 end
#configure
def configure() { |config| ... } -> Client::Configuration
Configure the GkeHubMembershipService Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
#create_membership
def create_membership(request, options = nil) -> ::Gapic::Operation
def create_membership(parent: nil, membership_id: nil, resource: nil, request_id: nil) -> ::Gapic::Operation
Creates a new Membership.
This is currently only supported for GKE clusters on Google Cloud. To register other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.
def create_membership(request, options = nil) -> ::Gapic::Operation
create_membership
via a request object, either of type
CreateMembershipRequest or an equivalent Hash.
- request (::Google::Cloud::GkeHub::V1beta1::CreateMembershipRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def create_membership(parent: nil, membership_id: nil, resource: nil, request_id: nil) -> ::Gapic::Operation
create_membership
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
parent (::String) — Required. The parent (project and location) where the Memberships will be created.
Specified in the format
projects/*/locations/*
. -
membership_id (::String) — Required. Client chosen ID for the membership.
membership_id
must be a valid RFC 1123 compliant DNS label:- At most 63 characters in length
- It must consist of lower case alphanumeric characters or
-
- 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. - resource (::Google::Cloud::GkeHub::V1beta1::Membership, ::Hash) — Required. The membership to create.
-
request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID
so that if you must retry your request, the server will know to ignore
the request if it has already been completed. The server will guarantee
that for at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/gke_hub/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::GkeHub::V1beta1::GkeHubMembershipService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::GkeHub::V1beta1::CreateMembershipRequest.new # Call the create_membership method. result = client.create_membership request # The returned object is of type Gapic::Operation. You can use this # object to check the status of an operation, cancel it, or wait # for results. Here is how to block until completion: result.wait_until_done! timeout: 60 if result.response? p result.response else puts "Error!" end
#delete_membership
def delete_membership(request, options = nil) -> ::Gapic::Operation
def delete_membership(name: nil, request_id: nil) -> ::Gapic::Operation
Removes a Membership.
This is currently only supported for GKE clusters on Google Cloud. To unregister other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.
def delete_membership(request, options = nil) -> ::Gapic::Operation
delete_membership
via a request object, either of type
DeleteMembershipRequest or an equivalent Hash.
- request (::Google::Cloud::GkeHub::V1beta1::DeleteMembershipRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_membership(name: nil, request_id: nil) -> ::Gapic::Operation
delete_membership
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The Membership resource name in the format
projects/*/locations/*/memberships/*
. -
request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID
so that if you must retry your request, the server will know to ignore
the request if it has already been completed. The server will guarantee
that for at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/gke_hub/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::GkeHub::V1beta1::GkeHubMembershipService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::GkeHub::V1beta1::DeleteMembershipRequest.new # Call the delete_membership method. result = client.delete_membership request # The returned object is of type Gapic::Operation. You can use this # object to check the status of an operation, cancel it, or wait # for results. Here is how to block until completion: result.wait_until_done! timeout: 60 if result.response? p result.response else puts "Error!" end
#generate_connect_manifest
def generate_connect_manifest(request, options = nil) -> ::Google::Cloud::GkeHub::V1beta1::GenerateConnectManifestResponse
def generate_connect_manifest(name: nil, connect_agent: nil, version: nil, is_upgrade: nil, registry: nil, image_pull_secret_content: nil) -> ::Google::Cloud::GkeHub::V1beta1::GenerateConnectManifestResponse
Generates the manifest for deployment of the GKE connect agent.
This method is used internally by Google-provided libraries. Most clients should not need to call this method directly.
def generate_connect_manifest(request, options = nil) -> ::Google::Cloud::GkeHub::V1beta1::GenerateConnectManifestResponse
generate_connect_manifest
via a request object, either of type
Google::Cloud::GkeHub::V1beta1::GenerateConnectManifestRequest or an equivalent Hash.
- request (::Google::Cloud::GkeHub::V1beta1::GenerateConnectManifestRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def generate_connect_manifest(name: nil, connect_agent: nil, version: nil, is_upgrade: nil, registry: nil, image_pull_secret_content: nil) -> ::Google::Cloud::GkeHub::V1beta1::GenerateConnectManifestResponse
generate_connect_manifest
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The Membership resource name the Agent will associate with, in the format
projects/*/locations/*/memberships/*
. - connect_agent (::Google::Cloud::GkeHub::V1beta1::ConnectAgent, ::Hash) — Optional. The connect agent to generate manifest for.
- version (::String) — Optional. The Connect agent version to use. Defaults to the most current version.
- is_upgrade (::Boolean) — Optional. If true, generate the resources for upgrade only. Some resources generated only for installation (e.g. secrets) will be excluded.
- registry (::String) — Optional. The registry to fetch the connect agent image from. Defaults to gcr.io/gkeconnect.
- image_pull_secret_content (::String) — Optional. The image pull secret content for the registry, if not public.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::GkeHub::V1beta1::GenerateConnectManifestResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/gke_hub/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::GkeHub::V1beta1::GkeHubMembershipService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::GkeHub::V1beta1::GenerateConnectManifestRequest.new # Call the generate_connect_manifest method. result = client.generate_connect_manifest request # The returned object is of type Google::Cloud::GkeHub::V1beta1::GenerateConnectManifestResponse. p result
#generate_exclusivity_manifest
def generate_exclusivity_manifest(request, options = nil) -> ::Google::Cloud::GkeHub::V1beta1::GenerateExclusivityManifestResponse
def generate_exclusivity_manifest(name: nil, crd_manifest: nil, cr_manifest: nil) -> ::Google::Cloud::GkeHub::V1beta1::GenerateExclusivityManifestResponse
GenerateExclusivityManifest generates the manifests to update the exclusivity artifacts in the cluster if needed.
Exclusivity artifacts include the Membership custom resource definition (CRD) and the singleton Membership custom resource (CR). Combined with ValidateExclusivity, exclusivity artifacts guarantee that a Kubernetes cluster is only registered to a single GKE Hub.
The Membership CRD is versioned, and may require conversion when the GKE Hub API server begins serving a newer version of the CRD and corresponding CR. The response will be the converted CRD and CR if there are any differences between the versions.
def generate_exclusivity_manifest(request, options = nil) -> ::Google::Cloud::GkeHub::V1beta1::GenerateExclusivityManifestResponse
generate_exclusivity_manifest
via a request object, either of type
Google::Cloud::GkeHub::V1beta1::GenerateExclusivityManifestRequest or an equivalent Hash.
- request (::Google::Cloud::GkeHub::V1beta1::GenerateExclusivityManifestRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def generate_exclusivity_manifest(name: nil, crd_manifest: nil, cr_manifest: nil) -> ::Google::Cloud::GkeHub::V1beta1::GenerateExclusivityManifestResponse
generate_exclusivity_manifest
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The Membership resource name in the format
projects/*/locations/*/memberships/*
. -
crd_manifest (::String) — Optional. The YAML manifest of the membership CRD retrieved by
kubectl get customresourcedefinitions membership
. Leave empty if the resource does not exist. -
cr_manifest (::String) — Optional. The YAML manifest of the membership CR retrieved by
kubectl get memberships membership
. Leave empty if the resource does not exist.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::GkeHub::V1beta1::GenerateExclusivityManifestResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/gke_hub/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::GkeHub::V1beta1::GkeHubMembershipService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::GkeHub::V1beta1::GenerateExclusivityManifestRequest.new # Call the generate_exclusivity_manifest method. result = client.generate_exclusivity_manifest request # The returned object is of type Google::Cloud::GkeHub::V1beta1::GenerateExclusivityManifestResponse. p result
#get_membership
def get_membership(request, options = nil) -> ::Google::Cloud::GkeHub::V1beta1::Membership
def get_membership(name: nil) -> ::Google::Cloud::GkeHub::V1beta1::Membership
Gets the details of a Membership.
def get_membership(request, options = nil) -> ::Google::Cloud::GkeHub::V1beta1::Membership
get_membership
via a request object, either of type
Google::Cloud::GkeHub::V1beta1::GetMembershipRequest or an equivalent Hash.
- request (::Google::Cloud::GkeHub::V1beta1::GetMembershipRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_membership(name: nil) -> ::Google::Cloud::GkeHub::V1beta1::Membership
get_membership
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The Membership resource name in the format
projects/*/locations/*/memberships/*
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::GkeHub::V1beta1::Membership)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/gke_hub/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::GkeHub::V1beta1::GkeHubMembershipService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::GkeHub::V1beta1::GetMembershipRequest.new # Call the get_membership method. result = client.get_membership request # The returned object is of type Google::Cloud::GkeHub::V1beta1::Membership. p result
#iam_policy_client
def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client
Get the associated client for mix-in of the IAMPolicy.
- (Google::Iam::V1::IAMPolicy::Client)
#initialize
def initialize() { |config| ... } -> Client
Create a new GkeHubMembershipService client object.
- (config) — Configure the GkeHubMembershipService client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::GkeHub::V1beta1::GkeHubMembershipService::Client.new # Create a client using a custom configuration client = ::Google::Cloud::GkeHub::V1beta1::GkeHubMembershipService::Client.new do |config| config.timeout = 10.0 end
#list_memberships
def list_memberships(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::GkeHub::V1beta1::Membership>
def list_memberships(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::GkeHub::V1beta1::Membership>
Lists Memberships in a given project and location.
def list_memberships(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::GkeHub::V1beta1::Membership>
list_memberships
via a request object, either of type
ListMembershipsRequest or an equivalent Hash.
- request (::Google::Cloud::GkeHub::V1beta1::ListMembershipsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_memberships(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::GkeHub::V1beta1::Membership>
list_memberships
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
parent (::String) — Required. The parent (project and location) where the Memberships will be listed.
Specified in the format
projects/*/locations/*
. -
page_size (::Integer) — Optional. When requesting a 'page' of resources,
page_size
specifies number of resources to return. If unspecified or set to 0, all resources will be returned. -
page_token (::String) — Optional. Token returned by previous call to
ListMemberships
which specifies the position in the list from where to continue listing the resources. -
filter (::String) —
Optional. Lists Memberships that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
Examples:
Name is
bar
in projectfoo-proj
and locationglobal
:name = "projects/foo-proj/locations/global/membership/bar"
Memberships that have a label called
foo
:labels.foo:*
Memberships that have a label called
foo
whose value isbar
:labels.foo = bar
Memberships in the CREATING state:
state = CREATING
- order_by (::String) — Optional. One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::GkeHub::V1beta1::Membership>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::GkeHub::V1beta1::Membership>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/gke_hub/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::GkeHub::V1beta1::GkeHubMembershipService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::GkeHub::V1beta1::ListMembershipsRequest.new # Call the list_memberships method. result = client.list_memberships request # The returned object is of type Gapic::PagedEnumerable. You can # iterate over all elements by calling #each, and the enumerable # will lazily make API calls to fetch subsequent pages. Other # methods are also available for managing paging directly. result.each do |response| # Each element is of type ::Google::Cloud::GkeHub::V1beta1::Membership. p response end
#location_client
def location_client() -> Google::Cloud::Location::Locations::Client
Get the associated client for mix-in of the Locations.
- (Google::Cloud::Location::Locations::Client)
#operations_client
def operations_client() -> ::Google::Cloud::GkeHub::V1beta1::GkeHubMembershipService::Operations
Get the associated client for long-running operations.
#update_membership
def update_membership(request, options = nil) -> ::Gapic::Operation
def update_membership(name: nil, update_mask: nil, resource: nil, request_id: nil) -> ::Gapic::Operation
Updates an existing Membership.
def update_membership(request, options = nil) -> ::Gapic::Operation
update_membership
via a request object, either of type
UpdateMembershipRequest or an equivalent Hash.
- request (::Google::Cloud::GkeHub::V1beta1::UpdateMembershipRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def update_membership(name: nil, update_mask: nil, resource: nil, request_id: nil) -> ::Gapic::Operation
update_membership
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The membership resource name in the format:
projects/[project_id]/locations/global/memberships/[membership_id]
- update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Mask of fields to update. At least one field path must be specified in this mask.
-
resource (::Google::Cloud::GkeHub::V1beta1::Membership, ::Hash) — Required. Only fields specified in update_mask are updated.
If you specify a field in the update_mask but don't specify its value here
that field will be deleted.
If you are updating a map field, set the value of a key to null or empty
string to delete the key from the map. It's not possible to update a key's
value to the empty string.
If you specify the update_mask to be a special path "*", fully replaces all
user-modifiable fields to match
resource
. -
request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID
so that if you must retry your request, the server will know to ignore
the request if it has already been completed. The server will guarantee
that for at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/gke_hub/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::GkeHub::V1beta1::GkeHubMembershipService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::GkeHub::V1beta1::UpdateMembershipRequest.new # Call the update_membership method. result = client.update_membership request # The returned object is of type Gapic::Operation. You can use this # object to check the status of an operation, cancel it, or wait # for results. Here is how to block until completion: result.wait_until_done! timeout: 60 if result.response? p result.response else puts "Error!" end
#validate_exclusivity
def validate_exclusivity(request, options = nil) -> ::Google::Cloud::GkeHub::V1beta1::ValidateExclusivityResponse
def validate_exclusivity(parent: nil, cr_manifest: nil, intended_membership: nil) -> ::Google::Cloud::GkeHub::V1beta1::ValidateExclusivityResponse
ValidateExclusivity validates the state of exclusivity in the cluster. The validation does not depend on an existing Hub membership resource.
def validate_exclusivity(request, options = nil) -> ::Google::Cloud::GkeHub::V1beta1::ValidateExclusivityResponse
validate_exclusivity
via a request object, either of type
ValidateExclusivityRequest or an equivalent Hash.
- request (::Google::Cloud::GkeHub::V1beta1::ValidateExclusivityRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def validate_exclusivity(parent: nil, cr_manifest: nil, intended_membership: nil) -> ::Google::Cloud::GkeHub::V1beta1::ValidateExclusivityResponse
validate_exclusivity
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
parent (::String) — Required. The parent (project and location) where the Memberships will be created.
Specified in the format
projects/*/locations/*
. - cr_manifest (::String) — Optional. The YAML of the membership CR in the cluster. Empty if the membership CR does not exist.
-
intended_membership (::String) — Required. The intended membership name under the
parent
. This method only does validation in anticipation of a CreateMembership call with the same name.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::GkeHub::V1beta1::ValidateExclusivityResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/gke_hub/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::GkeHub::V1beta1::GkeHubMembershipService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::GkeHub::V1beta1::ValidateExclusivityRequest.new # Call the validate_exclusivity method. result = client.validate_exclusivity request # The returned object is of type Google::Cloud::GkeHub::V1beta1::ValidateExclusivityResponse. p result