Reference documentation and code samples for the GKE Hub V1 API class Google::Cloud::GkeHub::V1::GkeHub::Client.
Client for the GkeHub service.
The GKE Hub service handles the registration of many Kubernetes clusters to Google Cloud, and the management of multi-cluster features over those clusters.
The GKE Hub service operates on the following resources:
GKE Hub is currently available in the global region and all regions in https://cloud.google.com/compute/docs/regions-zones. Feature is only available in global region while membership is global region and all the regions.
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
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all GkeHub clients ::Google::Cloud::GkeHub::V1::GkeHub::Client.configure do |config| config.timeout = 10.0 end
#configure
def configure() { |config| ... } -> Client::Configuration
Configure the GkeHub 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_feature
def create_feature(request, options = nil) -> ::Gapic::Operation
def create_feature(parent: nil, feature_id: nil, resource: nil, request_id: nil) -> ::Gapic::Operation
Adds a new Feature.
def create_feature(request, options = nil) -> ::Gapic::Operation
create_feature
via a request object, either of type
CreateFeatureRequest or an equivalent Hash.
- request (::Google::Cloud::GkeHub::V1::CreateFeatureRequest, ::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_feature(parent: nil, feature_id: nil, resource: nil, request_id: nil) -> ::Gapic::Operation
create_feature
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 Feature will be created.
Specified in the format
projects/*/locations/*
. - feature_id (::String) — The ID of the feature to create.
- resource (::Google::Cloud::GkeHub::V1::Feature, ::Hash) — The Feature resource 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/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::GkeHub::V1::GkeHub::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::GkeHub::V1::CreateFeatureRequest.new # Call the create_feature method. result = client.create_feature 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
#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::V1::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::V1::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/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::GkeHub::V1::GkeHub::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::GkeHub::V1::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
#delete_feature
def delete_feature(request, options = nil) -> ::Gapic::Operation
def delete_feature(name: nil, force: nil, request_id: nil) -> ::Gapic::Operation
Removes a Feature.
def delete_feature(request, options = nil) -> ::Gapic::Operation
delete_feature
via a request object, either of type
DeleteFeatureRequest or an equivalent Hash.
- request (::Google::Cloud::GkeHub::V1::DeleteFeatureRequest, ::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_feature(name: nil, force: nil, request_id: nil) -> ::Gapic::Operation
delete_feature
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 Feature resource name in the format
projects/*/locations/*/features/*
. -
force (::Boolean) — If set to true, the delete will ignore any outstanding resources for
this Feature (that is,
FeatureState.has_resources
is set to true). These resources will NOT be cleaned up or modified in any way. -
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/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::GkeHub::V1::GkeHub::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::GkeHub::V1::DeleteFeatureRequest.new # Call the delete_feature method. result = client.delete_feature 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
#delete_membership
def delete_membership(request, options = nil) -> ::Gapic::Operation
def 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.
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::V1::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, force: 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).
- force (::Boolean) — 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.
- (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/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::GkeHub::V1::GkeHub::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::GkeHub::V1::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
#generate_connect_manifest
def generate_connect_manifest(request, options = nil) -> ::Google::Cloud::GkeHub::V1::GenerateConnectManifestResponse
def generate_connect_manifest(name: nil, namespace: nil, proxy: nil, version: nil, is_upgrade: nil, registry: nil, image_pull_secret_content: nil) -> ::Google::Cloud::GkeHub::V1::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::V1::GenerateConnectManifestResponse
generate_connect_manifest
via a request object, either of type
Google::Cloud::GkeHub::V1::GenerateConnectManifestRequest or an equivalent Hash.
- request (::Google::Cloud::GkeHub::V1::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, namespace: nil, proxy: nil, version: nil, is_upgrade: nil, registry: nil, image_pull_secret_content: nil) -> ::Google::Cloud::GkeHub::V1::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/*
. -
namespace (::String) — Optional. Namespace for GKE Connect agent resources. Defaults to
gke-connect
.The Connect Agent is authorized automatically when run in the default namespace. Otherwise, explicit authorization must be granted with an additional IAM binding.
-
proxy (::String) — Optional. URI of a proxy if connectivity from the agent to
gkeconnect.googleapis.com requires the use of a proxy. Format must be in
the form
http(s)://{proxy_address}
, depending on the HTTP/HTTPS protocol supported by the proxy. This will direct the connect agent's outbound traffic through a HTTP(S) proxy. - 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::V1::GenerateConnectManifestResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/gke_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::GkeHub::V1::GkeHub::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::GkeHub::V1::GenerateConnectManifestRequest.new # Call the generate_connect_manifest method. result = client.generate_connect_manifest request # The returned object is of type Google::Cloud::GkeHub::V1::GenerateConnectManifestResponse. p result
#get_feature
def get_feature(request, options = nil) -> ::Google::Cloud::GkeHub::V1::Feature
def get_feature(name: nil) -> ::Google::Cloud::GkeHub::V1::Feature
Gets details of a single Feature.
def get_feature(request, options = nil) -> ::Google::Cloud::GkeHub::V1::Feature
get_feature
via a request object, either of type
Google::Cloud::GkeHub::V1::GetFeatureRequest or an equivalent Hash.
- request (::Google::Cloud::GkeHub::V1::GetFeatureRequest, ::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_feature(name: nil) -> ::Google::Cloud::GkeHub::V1::Feature
get_feature
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 Feature resource name in the format
projects/*/locations/*/features/*
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::GkeHub::V1::Feature)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/gke_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::GkeHub::V1::GkeHub::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::GkeHub::V1::GetFeatureRequest.new # Call the get_feature method. result = client.get_feature request # The returned object is of type Google::Cloud::GkeHub::V1::Feature. p result
#get_membership
def get_membership(request, options = nil) -> ::Google::Cloud::GkeHub::V1::Membership
def get_membership(name: nil) -> ::Google::Cloud::GkeHub::V1::Membership
Gets the details of a Membership.
def get_membership(request, options = nil) -> ::Google::Cloud::GkeHub::V1::Membership
get_membership
via a request object, either of type
Google::Cloud::GkeHub::V1::GetMembershipRequest or an equivalent Hash.
- request (::Google::Cloud::GkeHub::V1::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::V1::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::V1::Membership)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/gke_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::GkeHub::V1::GkeHub::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::GkeHub::V1::GetMembershipRequest.new # Call the get_membership method. result = client.get_membership request # The returned object is of type Google::Cloud::GkeHub::V1::Membership. p result
#initialize
def initialize() { |config| ... } -> Client
Create a new GkeHub client object.
- (config) — Configure the GkeHub client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::GkeHub::V1::GkeHub::Client.new # Create a client using a custom configuration client = ::Google::Cloud::GkeHub::V1::GkeHub::Client.new do |config| config.timeout = 10.0 end
#list_features
def list_features(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::GkeHub::V1::Feature>
def list_features(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::GkeHub::V1::Feature>
Lists Features in a given project and location.
def list_features(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::GkeHub::V1::Feature>
list_features
via a request object, either of type
ListFeaturesRequest or an equivalent Hash.
- request (::Google::Cloud::GkeHub::V1::ListFeaturesRequest, ::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_features(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::GkeHub::V1::Feature>
list_features
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 Features will be listed.
Specified in the format
projects/*/locations/*
. -
page_size (::Integer) — 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) — Token returned by previous call to
ListFeatures
which specifies the position in the list from where to continue listing the resources. -
filter (::String) —
Lists Features that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
Examples:
Feature with the name "servicemesh" in project "foo-proj":
name = "projects/foo-proj/locations/global/features/servicemesh"
Features that have a label called
foo
:labels.foo:*
Features that have a label called
foo
whose value isbar
:labels.foo = bar
- order_by (::String) — 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::V1::Feature>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::GkeHub::V1::Feature>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/gke_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::GkeHub::V1::GkeHub::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::GkeHub::V1::ListFeaturesRequest.new # Call the list_features method. result = client.list_features 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::V1::Feature. p item end
#list_memberships
def list_memberships(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::GkeHub::V1::Membership>
def list_memberships(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::GkeHub::V1::Membership>
Lists Memberships in a given project and location.
def list_memberships(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::GkeHub::V1::Membership>
list_memberships
via a request object, either of type
ListMembershipsRequest or an equivalent Hash.
- request (::Google::Cloud::GkeHub::V1::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::V1::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/*
.projects/*/locations/-
list memberships in all the regions. -
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::V1::Membership>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::GkeHub::V1::Membership>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/gke_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::GkeHub::V1::GkeHub::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::GkeHub::V1::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::V1::Membership. p item end
#operations_client
def operations_client() -> ::Google::Cloud::GkeHub::V1::GkeHub::Operations
Get the associated client for long-running operations.
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)
#update_feature
def update_feature(request, options = nil) -> ::Gapic::Operation
def update_feature(name: nil, update_mask: nil, resource: nil, request_id: nil) -> ::Gapic::Operation
Updates an existing Feature.
def update_feature(request, options = nil) -> ::Gapic::Operation
update_feature
via a request object, either of type
UpdateFeatureRequest or an equivalent Hash.
- request (::Google::Cloud::GkeHub::V1::UpdateFeatureRequest, ::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_feature(name: nil, update_mask: nil, resource: nil, request_id: nil) -> ::Gapic::Operation
update_feature
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 Feature resource name in the format
projects/*/locations/*/features/*
. - update_mask (::Google::Protobuf::FieldMask, ::Hash) — Mask of fields to update.
-
resource (::Google::Cloud::GkeHub::V1::Feature, ::Hash) — 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/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::GkeHub::V1::GkeHub::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::GkeHub::V1::UpdateFeatureRequest.new # Call the update_feature method. result = client.update_feature 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
#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::V1::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/*/locations/*/memberships/*
. - update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Mask of fields to update.
-
resource (::Google::Cloud::GkeHub::V1::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/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::GkeHub::V1::GkeHub::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::GkeHub::V1::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