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 {::Google::Cloud::GkeHub::V1beta1::Membership 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.

Attributes

gke_hub_membership_service_stub[R]

@private

operations_client[R]

Get the associated client for long-running operations.

@return [::Google::Cloud::GkeHub::V1beta1::GkeHubMembershipService::Operations]

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the GkeHubMembershipService Client class.

See {::Google::Cloud::GkeHub::V1beta1::GkeHubMembershipService::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all GkeHubMembershipService clients
::Google::Cloud::GkeHub::V1beta1::GkeHubMembershipService::Client.configure do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/client.rb, line 63
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "GkeHub", "V1beta1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 60.0
    default_config.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end
new() { |config| ... } click to toggle source

Create a new GkeHubMembershipService client object.

@example

# 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

@yield [config] Configure the GkeHubMembershipService client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/client.rb, line 121
def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/gkehub/v1beta1/membership_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.endpoint = @config.endpoint
  end

  @gke_hub_membership_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::GkeHub::V1beta1::GkeHubMembershipService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

configure() { |config| ... } click to toggle source

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 {::Google::Cloud::GkeHub::V1beta1::GkeHubMembershipService::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/client.rb, line 100
def configure
  yield @config if block_given?
  @config
end
create_membership(request, options = nil) { |response, operation| ... } click to toggle source

Creates a new Membership.

**This is currently only supported for GKE clusters on Google Cloud**. To register other clusters, follow the instructions at cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.

@overload create_membership(request, options = nil)

Pass arguments to `create_membership` via a request object, either of type
{::Google::Cloud::GkeHub::V1beta1::CreateMembershipRequest} or an equivalent Hash.

@param 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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload create_membership(parent: nil, membership_id: nil, resource: nil, request_id: nil)

Pass arguments to `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).

@param parent [::String]
  Required. The parent (project and location) where the Memberships will be created.
  Specified in the format `projects/*/locations/*`.
@param membership_id [::String]
  Required. Client chosen ID for the membership. `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.
@param resource [::Google::Cloud::GkeHub::V1beta1::Membership, ::Hash]
  Required. The membership to create.
@param 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).

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::Operation]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/client.rb, line 402
def create_membership request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::GkeHub::V1beta1::CreateMembershipRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_membership.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::GkeHub::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_membership.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_membership.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @gke_hub_membership_service_stub.call_rpc :create_membership, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
delete_membership(request, options = nil) { |response, operation| ... } click to toggle source

Removes a Membership.

**This is currently only supported for GKE clusters on Google Cloud**. To unregister other clusters, follow the instructions at cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.

@overload delete_membership(request, options = nil)

Pass arguments to `delete_membership` via a request object, either of type
{::Google::Cloud::GkeHub::V1beta1::DeleteMembershipRequest} or an equivalent Hash.

@param 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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload delete_membership(name: nil, request_id: nil)

Pass arguments to `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).

@param name [::String]
  Required. The Membership resource name in the format
  `projects/*/locations/*/memberships/*`.
@param 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).

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::Operation]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/client.rb, line 490
def delete_membership request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::GkeHub::V1beta1::DeleteMembershipRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_membership.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::GkeHub::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_membership.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_membership.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @gke_hub_membership_service_stub.call_rpc :delete_membership, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
generate_connect_manifest(request, options = nil) { |response, operation| ... } click to toggle source

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.

@overload generate_connect_manifest(request, options = nil)

Pass arguments to `generate_connect_manifest` via a request object, either of type
{::Google::Cloud::GkeHub::V1beta1::GenerateConnectManifestRequest} or an equivalent Hash.

@param 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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload generate_connect_manifest(name: nil, connect_agent: nil, version: nil, is_upgrade: nil, registry: nil, image_pull_secret_content: nil)

Pass arguments to `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).

@param name [::String]
  Required. The Membership resource name the Agent will associate with, in the format
  `projects/*/locations/*/memberships/*`.
@param connect_agent [::Google::Cloud::GkeHub::V1beta1::ConnectAgent, ::Hash]
  Optional. The connect agent to generate manifest for.
@param version [::String]
  Optional. The Connect agent version to use. Defaults to the most current version.
@param is_upgrade [::Boolean]
  Optional. If true, generate the resources for upgrade only. Some resources
  generated only for installation (e.g. secrets) will be excluded.
@param registry [::String]
  Optional. The registry to fetch the connect agent image from. Defaults to
  gcr.io/gkeconnect.
@param image_pull_secret_content [::String]
  Optional. The image pull secret content for the registry, if not public.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::GkeHub::V1beta1::GenerateConnectManifestResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::GkeHub::V1beta1::GenerateConnectManifestResponse]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/client.rb, line 671
def generate_connect_manifest request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::GkeHub::V1beta1::GenerateConnectManifestRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.generate_connect_manifest.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::GkeHub::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.generate_connect_manifest.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.generate_connect_manifest.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @gke_hub_membership_service_stub.call_rpc :generate_connect_manifest, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
generate_exclusivity_manifest(request, options = nil) { |response, operation| ... } click to toggle source

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.

@overload generate_exclusivity_manifest(request, options = nil)

Pass arguments to `generate_exclusivity_manifest` via a request object, either of type
{::Google::Cloud::GkeHub::V1beta1::GenerateExclusivityManifestRequest} or an equivalent Hash.

@param 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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload generate_exclusivity_manifest(name: nil, crd_manifest: nil, cr_manifest: nil)

Pass arguments to `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).

@param name [::String]
  Required. The Membership resource name in the format
  `projects/*/locations/*/memberships/*`.
@param 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.
@param 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.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::GkeHub::V1beta1::GenerateExclusivityManifestResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::GkeHub::V1beta1::GenerateExclusivityManifestResponse]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/client.rb, line 835
def generate_exclusivity_manifest request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::GkeHub::V1beta1::GenerateExclusivityManifestRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.generate_exclusivity_manifest.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::GkeHub::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.generate_exclusivity_manifest.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.generate_exclusivity_manifest.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @gke_hub_membership_service_stub.call_rpc :generate_exclusivity_manifest, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
get_membership(request, options = nil) { |response, operation| ... } click to toggle source

Gets the details of a Membership.

@overload get_membership(request, options = nil)

Pass arguments to `get_membership` via a request object, either of type
{::Google::Cloud::GkeHub::V1beta1::GetMembershipRequest} or an equivalent Hash.

@param 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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload get_membership(name: nil)

Pass arguments to `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).

@param name [::String]
  Required. The Membership resource name in the format
  `projects/*/locations/*/memberships/*`.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::GkeHub::V1beta1::Membership] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::GkeHub::V1beta1::Membership]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/client.rb, line 303
def get_membership request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::GkeHub::V1beta1::GetMembershipRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_membership.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::GkeHub::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_membership.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_membership.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @gke_hub_membership_service_stub.call_rpc :get_membership, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
list_memberships(request, options = nil) { |response, operation| ... } click to toggle source

Lists Memberships in a given project and location.

@overload list_memberships(request, options = nil)

Pass arguments to `list_memberships` via a request object, either of type
{::Google::Cloud::GkeHub::V1beta1::ListMembershipsRequest} or an equivalent Hash.

@param 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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload list_memberships(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)

Pass arguments to `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).

@param parent [::String]
  Required. The parent (project and location) where the Memberships will be listed.
  Specified in the format `projects/*/locations/*`.
@param 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.
@param 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.
@param 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 project `foo-proj` and location `global`:

        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 is `bar`:

        labels.foo = bar

    - Memberships in the CREATING state:

        state = CREATING
@param order_by [::String]
  Optional. One or more fields to compare and use to sort the output.
  See https://google.aip.dev/132#ordering.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::GkeHub::V1beta1::Membership>] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::PagedEnumerable<::Google::Cloud::GkeHub::V1beta1::Membership>]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/client.rb, line 233
def list_memberships request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::GkeHub::V1beta1::ListMembershipsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_memberships.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::GkeHub::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_memberships.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_memberships.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @gke_hub_membership_service_stub.call_rpc :list_memberships, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @gke_hub_membership_service_stub, :list_memberships, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
update_membership(request, options = nil) { |response, operation| ... } click to toggle source

Updates an existing Membership.

@overload update_membership(request, options = nil)

Pass arguments to `update_membership` via a request object, either of type
{::Google::Cloud::GkeHub::V1beta1::UpdateMembershipRequest} or an equivalent Hash.

@param 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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload update_membership(name: nil, update_mask: nil, resource: nil, request_id: nil)

Pass arguments to `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).

@param name [::String]
  Required. The membership resource name in the format:
  `projects/[project_id]/locations/global/memberships/[membership_id]`
@param update_mask [::Google::Protobuf::FieldMask, ::Hash]
  Required. Mask of fields to update. At least one field path must be specified in this
  mask.
@param 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`.
@param 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).

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::Operation]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/client.rb, line 586
def update_membership request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::GkeHub::V1beta1::UpdateMembershipRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_membership.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::GkeHub::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_membership.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_membership.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @gke_hub_membership_service_stub.call_rpc :update_membership, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
validate_exclusivity(request, options = nil) { |response, operation| ... } click to toggle source

ValidateExclusivity validates the state of exclusivity in the cluster. The validation does not depend on an existing Hub membership resource.

@overload validate_exclusivity(request, options = nil)

Pass arguments to `validate_exclusivity` via a request object, either of type
{::Google::Cloud::GkeHub::V1beta1::ValidateExclusivityRequest} or an equivalent Hash.

@param 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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload validate_exclusivity(parent: nil, cr_manifest: nil, intended_membership: nil)

Pass arguments to `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).

@param parent [::String]
  Required. The parent (project and location) where the Memberships will be created.
  Specified in the format `projects/*/locations/*`.
@param cr_manifest [::String]
  Optional. The YAML of the membership CR in the cluster. Empty if the membership
  CR does not exist.
@param 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.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::GkeHub::V1beta1::ValidateExclusivityResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::GkeHub::V1beta1::ValidateExclusivityResponse]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/client.rb, line 747
def validate_exclusivity request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::GkeHub::V1beta1::ValidateExclusivityRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.validate_exclusivity.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::GkeHub::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.validate_exclusivity.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.validate_exclusivity.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @gke_hub_membership_service_stub.call_rpc :validate_exclusivity, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end