Class: Google::Cloud::GkeHub::V1beta1::GkeHubMembershipService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/rest/client.rb

Overview

REST 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 available in the global region and all regions in https://cloud.google.com/compute/docs/regions-zones.

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.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#location_path, #membership_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new GkeHubMembershipService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::GkeHub::V1beta1::GkeHubMembershipService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::GkeHub::V1beta1::GkeHubMembershipService::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the GkeHubMembershipService client.

Yield Parameters:



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/rest/client.rb', line 142

def initialize
  # 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.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_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 = ::Google::Cloud::GkeHub::V1beta1::GkeHubMembershipService::Rest::Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @gke_hub_membership_service_stub = ::Google::Cloud::GkeHub::V1beta1::GkeHubMembershipService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @gke_hub_membership_service_stub.logger(stub: true)&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end

  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @gke_hub_membership_service_stub.endpoint
    config.universe_domain = @gke_hub_membership_service_stub.universe_domain
    config.bindings_override = @config.bindings_override
    config.logger = @gke_hub_membership_service_stub.logger if config.respond_to? :logger=
  end

  @iam_policy_client = Google::Iam::V1::IAMPolicy::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @gke_hub_membership_service_stub.endpoint
    config.universe_domain = @gke_hub_membership_service_stub.universe_domain
    config.bindings_override = @config.bindings_override
    config.logger = @gke_hub_membership_service_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

#iam_policy_client ⇒ Google::Iam::V1::IAMPolicy::Rest::Client (readonly)

Get the associated client for mix-in of the IAMPolicy.

Returns:

  • (Google::Iam::V1::IAMPolicy::Rest::Client) 


228
229
230
 
# File 'lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/rest/client.rb', line 228

def iam_policy_client
  @iam_policy_client
end

#location_client ⇒ Google::Cloud::Location::Locations::Rest::Client (readonly)

Get the associated client for mix-in of the Locations.

Returns:

  • (Google::Cloud::Location::Locations::Rest::Client) 


221
222
223
 
# File 'lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/rest/client.rb', line 221

def location_client
  @location_client
end

#operations_client ⇒ ::Google::Cloud::GkeHub::V1beta1::GkeHubMembershipService::Rest::Operations (readonly)

Get the associated client for long-running operations.

Returns:



214
215
216
 
# File 'lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/rest/client.rb', line 214

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the GkeHubMembershipService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/rest/client.rb', line 75

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

Instance Method Details

#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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



112
113
114
115
 
# File 'lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/rest/client.rb', line 112

def configure
  yield @config if block_given?
  @config
end

#create_membership(request, options = nil) ⇒ ::Gapic::Operation #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.

Examples:

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::Rest::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 it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_membership(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to create_membership via a request object, either of type CreateMembershipRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #create_membership(parent: nil, membership_id: nil, resource: nil, request_id: nil) ⇒ ::Gapic::Operation

    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).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent (project and location) where the Memberships will be created. Specified in the format projects/*/locations/*.

    • membership_id (::String) (defaults to: nil) —

      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.

    • resource (::Google::Cloud::GkeHub::V1beta1::Membership, ::Hash) (defaults to: nil) —

      Required. The membership to create.

    • request_id (::String) (defaults to: nil) —

      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).

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/rest/client.rb', line 519

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
  call_metadata = @config.rpcs.create_membership.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_membership.timeout,
                         metadata:     call_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.create_membership request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_membership(request, options = nil) ⇒ ::Gapic::Operation #delete_membership(name: nil, request_id: nil, force: 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.

Examples:

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::Rest::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 it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #delete_membership(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_membership via a request object, either of type DeleteMembershipRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #delete_membership(name: nil, request_id: nil, force: nil) ⇒ ::Gapic::Operation

    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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The Membership resource name in the format projects/*/locations/*/memberships/*.

    • request_id (::String) (defaults to: nil) —

      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).

    • force (::Boolean) (defaults to: nil) —

      Optional. If set to true, any subresource from this Membership will also be deleted. Otherwise, the request will only work if the Membership has no subresource.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/rest/client.rb', line 629

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
  call_metadata = @config.rpcs.delete_membership.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_membership.timeout,
                         metadata:     call_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.delete_membership request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#generate_connect_manifest(request, options = nil) ⇒ ::Google::Cloud::GkeHub::V1beta1::GenerateConnectManifestResponse #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.

Examples:

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

Overloads:

  • #generate_connect_manifest(request, options = nil) ⇒ ::Google::Cloud::GkeHub::V1beta1::GenerateConnectManifestResponse

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

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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

    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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The Membership resource name the Agent will associate with, in the format projects/*/locations/*/memberships/*.

    • connect_agent (::Google::Cloud::GkeHub::V1beta1::ConnectAgent, ::Hash) (defaults to: nil) —

      Optional. The connect agent to generate manifest for.

    • version (::String) (defaults to: nil) —

      Optional. The Connect agent version to use. Defaults to the most current version.

    • is_upgrade (::Boolean) (defaults to: nil) —

      Optional. If true, generate the resources for upgrade only. Some resources generated only for installation (e.g. secrets) will be excluded.

    • registry (::String) (defaults to: nil) —

      Optional. The registry to fetch the connect agent image from. Defaults to gcr.io/gkeconnect.

    • image_pull_secret_content (::String) (defaults to: nil) —

      Optional. The image pull secret content for the registry, if not public.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
 
# File 'lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/rest/client.rb', line 840

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
  call_metadata = @config.rpcs.generate_connect_manifest.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.generate_connect_manifest.timeout,
                         metadata:     call_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.generate_connect_manifest request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#generate_exclusivity_manifest(request, options = nil) ⇒ ::Google::Cloud::GkeHub::V1beta1::GenerateExclusivityManifestResponse #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.

Examples:

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

Overloads:

  • #generate_exclusivity_manifest(request, options = nil) ⇒ ::Google::Cloud::GkeHub::V1beta1::GenerateExclusivityManifestResponse

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

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #generate_exclusivity_manifest(name: nil, crd_manifest: nil, cr_manifest: nil) ⇒ ::Google::Cloud::GkeHub::V1beta1::GenerateExclusivityManifestResponse

    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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The Membership resource name in the format projects/*/locations/*/memberships/*.

    • crd_manifest (::String) (defaults to: nil) —

      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) (defaults to: nil) —

      Optional. The YAML manifest of the membership CR retrieved by kubectl get memberships membership. Leave empty if the resource does not exist.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
 
# File 'lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/rest/client.rb', line 1025

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
  call_metadata = @config.rpcs.generate_exclusivity_manifest.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.generate_exclusivity_manifest.timeout,
                         metadata:     call_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.generate_exclusivity_manifest request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_membership(request, options = nil) ⇒ ::Google::Cloud::GkeHub::V1beta1::Membership #get_membership(name: nil) ⇒ ::Google::Cloud::GkeHub::V1beta1::Membership

Gets the details of a Membership.

Examples:

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

Overloads:

  • #get_membership(request, options = nil) ⇒ ::Google::Cloud::GkeHub::V1beta1::Membership

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

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_membership(name: nil) ⇒ ::Google::Cloud::GkeHub::V1beta1::Membership

    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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The Membership resource name in the format projects/*/locations/*/memberships/*.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/rest/client.rb', line 403

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
  call_metadata = @config.rpcs.get_membership.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_membership.timeout,
                         metadata:     call_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.get_membership request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_memberships(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::GkeHub::V1beta1::Membership> #list_memberships(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::GkeHub::V1beta1::Membership>

Lists Memberships in a given project and location.

Examples:

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::Rest::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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::GkeHub::V1beta1::Membership.
  p item
end

Overloads:

  • #list_memberships(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::GkeHub::V1beta1::Membership>

    Pass arguments to list_memberships via a request object, either of type ListMembershipsRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_memberships(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::GkeHub::V1beta1::Membership>

    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).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent (project and location) where the Memberships will be listed. Specified in the format projects/*/locations/*. projects/*/locations/- list memberships in all the regions.

    • page_size (::Integer) (defaults to: nil) —

      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) (defaults to: nil) —

      Optional. Token returned by previous call to ListMemberships which specifies the position in the list from where to continue listing the resources.

    • filter (::String) (defaults to: nil) —

      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

    • order_by (::String) (defaults to: nil) —

      Optional. One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/rest/client.rb', line 322

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
  call_metadata = @config.rpcs.list_memberships.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_memberships.timeout,
                         metadata:     call_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.list_memberships request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @gke_hub_membership_service_stub, :list_memberships, "resources", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


235
236
237
 
# File 'lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/rest/client.rb', line 235

def logger
  @gke_hub_membership_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


122
123
124
 
# File 'lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/rest/client.rb', line 122

def universe_domain
  @gke_hub_membership_service_stub.universe_domain
end

#update_membership(request, options = nil) ⇒ ::Gapic::Operation #update_membership(name: nil, update_mask: nil, resource: nil, request_id: nil) ⇒ ::Gapic::Operation

Updates an existing Membership.

Examples:

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::Rest::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 it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #update_membership(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to update_membership via a request object, either of type UpdateMembershipRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #update_membership(name: nil, update_mask: nil, resource: nil, request_id: nil) ⇒ ::Gapic::Operation

    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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The membership resource name in the format: projects/[project_id]/locations/global/memberships/[membership_id]

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Required. Mask of fields to update. At least one field path must be specified in this mask.

    • resource (::Google::Cloud::GkeHub::V1beta1::Membership, ::Hash) (defaults to: nil) —

      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) (defaults to: nil) —

      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).

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/rest/client.rb', line 743

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
  call_metadata = @config.rpcs.update_membership.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_membership.timeout,
                         metadata:     call_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.update_membership request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#validate_exclusivity(request, options = nil) ⇒ ::Google::Cloud::GkeHub::V1beta1::ValidateExclusivityResponse #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.

Examples:

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

Overloads:

  • #validate_exclusivity(request, options = nil) ⇒ ::Google::Cloud::GkeHub::V1beta1::ValidateExclusivityResponse

    Pass arguments to validate_exclusivity via a request object, either of type ValidateExclusivityRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #validate_exclusivity(parent: nil, cr_manifest: nil, intended_membership: nil) ⇒ ::Google::Cloud::GkeHub::V1beta1::ValidateExclusivityResponse

    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).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent (project and location) where the Memberships will be created. Specified in the format projects/*/locations/*.

    • cr_manifest (::String) (defaults to: nil) —

      Optional. The YAML of the membership CR in the cluster. Empty if the membership CR does not exist.

    • intended_membership (::String) (defaults to: nil) —

      Required. The intended membership name under the parent. This method only does validation in anticipation of a CreateMembership call with the same name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
 
# File 'lib/google/cloud/gke_hub/v1beta1/gke_hub_membership_service/rest/client.rb', line 927

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
  call_metadata = @config.rpcs.validate_exclusivity.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.validate_exclusivity.timeout,
                         metadata:     call_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.validate_exclusivity request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end