# frozen_string_literal: true
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
require "gapic/common"
require "gapic/config"
require "gapic/config/method"
require "google/cloud/errors"
require "google/cloud/service_directory/v1beta1/version"
require "google/cloud/servicedirectory/v1beta1/registration_service_pb"
require "google/cloud/service_directory/v1beta1/registration_service/credentials"
require "google/cloud/service_directory/v1beta1/registration_service/paths"
module Google
module Cloud
module ServiceDirectory
module V1beta1
module RegistrationService
# Service that implements RegistrationService API.
class Client
include Paths
# @private
attr_reader :registration_service_stub
##
# Configure the RegistrationService Client class.
#
# See {Google::Cloud::ServiceDirectory::V1beta1::RegistrationService::Client::Configuration}
# for a description of the configuration fields.
#
# ## Example
#
# To modify the configuration for all RegistrationService clients:
#
# Google::Cloud::ServiceDirectory::V1beta1::RegistrationService::Client.configure do |config|
# config.timeout = 10_000
# end
#
# @yield [config] Configure the Client client.
# @yieldparam config [Client::Configuration]
#
# @return [Client::Configuration]
#
def self.configure
@configure ||= begin
namespace = ["Google", "Cloud", "ServiceDirectory", "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 = 15.0
default_config.retry_policy = {
initial_delay: 1.0,
max_delay: 60.0,
multiplier: 1.3,
retry_codes: ["UNAVAILABLE", "UNKNOWN"]
}
default_config
end
yield @configure if block_given?
@configure
end
##
# Configure the RegistrationService 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::ServiceDirectory::V1beta1::RegistrationService::Client::Configuration}
# for a description of the configuration fields.
#
# @yield [config] Configure the Client client.
# @yieldparam config [Client::Configuration]
#
# @return [Client::Configuration]
#
def configure
yield @config if block_given?
@config
end
##
# Create a new RegistrationService client object.
#
# ## Examples
#
# To create a new RegistrationService client with the default
# configuration:
#
# client = Google::Cloud::ServiceDirectory::V1beta1::RegistrationService::Client.new
#
# To create a new RegistrationService client with a custom
# configuration:
#
# client = Google::Cloud::ServiceDirectory::V1beta1::RegistrationService::Client.new do |config|
# config.timeout = 10_000
# end
#
# @yield [config] Configure the RegistrationService client.
# @yieldparam config [Client::Configuration]
#
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/servicedirectory/v1beta1/registration_service_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
credentials ||= Credentials.default scope: @config.scope
if credentials.is_a?(String) || credentials.is_a?(Hash)
credentials = Credentials.new credentials, scope: @config.scope
end
@quota_project_id = credentials.respond_to?(:quota_project_id) ? credentials.quota_project_id : nil
@registration_service_stub = Gapic::ServiceStub.new(
Google::Cloud::ServiceDirectory::V1beta1::RegistrationService::Stub,
credentials: credentials,
endpoint: @config.endpoint,
channel_args: @config.channel_args,
interceptors: @config.interceptors
)
end
# Service calls
##
# Creates a namespace, and returns the new Namespace.
#
# @overload create_namespace(request, options = nil)
# @param request [Google::Cloud::ServiceDirectory::V1beta1::CreateNamespaceRequest | Hash]
# Creates a namespace, and returns the new Namespace.
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload create_namespace(parent: nil, namespace_id: nil, namespace: nil)
# @param parent [String]
# Required. The resource name of the project and location the namespace
# will be created in.
# @param namespace_id [String]
# Required. The Resource ID must be 1-63 characters long, and comply with
# <a href="https://www.ietf.org/rfc/rfc1035.txt" target="_blank">RFC1035</a>.
# Specifically, the name must be 1-63 characters long and match the regular
# expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?` which means the first
# character must be a lowercase letter, and all following characters must
# be a dash, lowercase letter, or digit, except the last character, which
# cannot be a dash.
# @param namespace [Google::Cloud::ServiceDirectory::V1beta1::Namespace | Hash]
# Required. A namespace with initial fields set.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Google::Cloud::ServiceDirectory::V1beta1::Namespace]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Google::Cloud::ServiceDirectory::V1beta1::Namespace]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def create_namespace request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Cloud::ServiceDirectory::V1beta1::CreateNamespaceRequest
# 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_namespace.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::ServiceDirectory::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_namespace.timeout,
metadata: metadata,
retry_policy: @config.rpcs.create_namespace.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@registration_service_stub.call_rpc :create_namespace, 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
##
# Lists all namespaces.
#
# @overload list_namespaces(request, options = nil)
# @param request [Google::Cloud::ServiceDirectory::V1beta1::ListNamespacesRequest | Hash]
# Lists all namespaces.
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload list_namespaces(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
# @param parent [String]
# Required. The resource name of the project and location whose namespaces we'd like to
# list.
# @param page_size [Integer]
# Optional. The maximum number of items to return.
# @param page_token [String]
# Optional. The next_page_token value returned from a previous List request, if any.
# @param filter [String]
# Optional. The filter to list result by.
#
# General filter string syntax:
# <field> <operator> <value> (<logical connector>)
# <field> can be "name", or "labels.<key>" for map field.
# <operator> can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS, and
# is roughly the same as "=".
# <value> must be the same data type as field.
# <logical connector> can be "AND, OR, NOT".
#
# Examples of valid filters:
# * "labels.owner" returns Namespaces that have a label with the key "owner"
# this is the same as "labels:owner".
# * "labels.protocol=gRPC" returns Namespaces that have key/value
# "protocol=gRPC".
# * "name>projects/my-project/locations/us-east/namespaces/namespace-c"
# returns Namespaces that have name that is alphabetically later than the
# string, so "namespace-e" will be returned but "namespace-a" will not be.
# * "labels.owner!=sd AND labels.foo=bar" returns Namespaces that have
# "owner" in label key but value is not "sd" AND have key/value foo=bar.
# * "doesnotexist.foo=bar" returns an empty list. Note that Namespace doesn't
# have a field called "doesnotexist". Since the filter does not match any
# Namespaces, it returns no results.
# @param order_by [String]
# Optional. The order to list result by.
#
# General order by string syntax:
# <field> (<asc|desc>) (,)
# <field> allows values \\{"name"}
# <asc/desc> ascending or descending order by <field>. If this is left
# blank, "asc" is used.
# Note that an empty order_by string result in default order, which is order
# by name in ascending order.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Gapic::PagedEnumerable<Google::Cloud::ServiceDirectory::V1beta1::Namespace>]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Gapic::PagedEnumerable<Google::Cloud::ServiceDirectory::V1beta1::Namespace>]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def list_namespaces request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Cloud::ServiceDirectory::V1beta1::ListNamespacesRequest
# 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_namespaces.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::ServiceDirectory::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_namespaces.timeout,
metadata: metadata,
retry_policy: @config.rpcs.list_namespaces.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@registration_service_stub.call_rpc :list_namespaces, request, options: options do |response, operation|
response = Gapic::PagedEnumerable.new @registration_service_stub, :list_namespaces, 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
##
# Gets a namespace.
#
# @overload get_namespace(request, options = nil)
# @param request [Google::Cloud::ServiceDirectory::V1beta1::GetNamespaceRequest | Hash]
# Gets a namespace.
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload get_namespace(name: nil)
# @param name [String]
# Required. The name of the namespace to retrieve.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Google::Cloud::ServiceDirectory::V1beta1::Namespace]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Google::Cloud::ServiceDirectory::V1beta1::Namespace]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def get_namespace request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Cloud::ServiceDirectory::V1beta1::GetNamespaceRequest
# 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_namespace.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::ServiceDirectory::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_namespace.timeout,
metadata: metadata,
retry_policy: @config.rpcs.get_namespace.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@registration_service_stub.call_rpc :get_namespace, 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
##
# Updates a namespace.
#
# @overload update_namespace(request, options = nil)
# @param request [Google::Cloud::ServiceDirectory::V1beta1::UpdateNamespaceRequest | Hash]
# Updates a namespace.
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload update_namespace(namespace: nil, update_mask: nil)
# @param namespace [Google::Cloud::ServiceDirectory::V1beta1::Namespace | Hash]
# Required. The updated namespace.
# @param update_mask [Google::Protobuf::FieldMask | Hash]
# Required. List of fields to be updated in this request.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Google::Cloud::ServiceDirectory::V1beta1::Namespace]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Google::Cloud::ServiceDirectory::V1beta1::Namespace]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def update_namespace request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Cloud::ServiceDirectory::V1beta1::UpdateNamespaceRequest
# 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_namespace.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::ServiceDirectory::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {
"namespace.name" => request.namespace.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_namespace.timeout,
metadata: metadata,
retry_policy: @config.rpcs.update_namespace.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@registration_service_stub.call_rpc :update_namespace, 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
##
# Deletes a namespace. This also deletes all services and endpoints in
# the namespace.
#
# @overload delete_namespace(request, options = nil)
# @param request [Google::Cloud::ServiceDirectory::V1beta1::DeleteNamespaceRequest | Hash]
# Deletes a namespace. This also deletes all services and endpoints in
# the namespace.
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload delete_namespace(name: nil)
# @param name [String]
# Required. The name of the namespace to delete.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Google::Protobuf::Empty]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Google::Protobuf::Empty]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def delete_namespace request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Cloud::ServiceDirectory::V1beta1::DeleteNamespaceRequest
# 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_namespace.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::ServiceDirectory::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_namespace.timeout,
metadata: metadata,
retry_policy: @config.rpcs.delete_namespace.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@registration_service_stub.call_rpc :delete_namespace, 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
##
# Creates a service, and returns the new Service.
#
# @overload create_service(request, options = nil)
# @param request [Google::Cloud::ServiceDirectory::V1beta1::CreateServiceRequest | Hash]
# Creates a service, and returns the new Service.
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload create_service(parent: nil, service_id: nil, service: nil)
# @param parent [String]
# Required. The resource name of the namespace this service will belong to.
# @param service_id [String]
# Required. The Resource ID must be 1-63 characters long, and comply with
# <a href="https://www.ietf.org/rfc/rfc1035.txt" target="_blank">RFC1035</a>.
# Specifically, the name must be 1-63 characters long and match the regular
# expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?` which means the first
# character must be a lowercase letter, and all following characters must
# be a dash, lowercase letter, or digit, except the last character, which
# cannot be a dash.
# @param service [Google::Cloud::ServiceDirectory::V1beta1::Service | Hash]
# Required. A service with initial fields set.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Google::Cloud::ServiceDirectory::V1beta1::Service]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Google::Cloud::ServiceDirectory::V1beta1::Service]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def create_service request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Cloud::ServiceDirectory::V1beta1::CreateServiceRequest
# 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_service.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::ServiceDirectory::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_service.timeout,
metadata: metadata,
retry_policy: @config.rpcs.create_service.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@registration_service_stub.call_rpc :create_service, 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
##
# Lists all services belonging to a namespace.
#
# @overload list_services(request, options = nil)
# @param request [Google::Cloud::ServiceDirectory::V1beta1::ListServicesRequest | Hash]
# Lists all services belonging to a namespace.
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload list_services(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
# @param parent [String]
# Required. The resource name of the namespace whose services we'd
# like to list.
# @param page_size [Integer]
# Optional. The maximum number of items to return.
# @param page_token [String]
# Optional. The next_page_token value returned from a previous List request,
# if any.
# @param filter [String]
# Optional. The filter to list result by.
#
# General filter string syntax:
# <field> <operator> <value> (<logical connector>)
# <field> can be "name", or "metadata.<key>" for map field.
# <operator> can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS, and
# is roughly the same as "=".
# <value> must be the same data type as field.
# <logical connector> can be "AND, OR, NOT".
#
# Examples of valid filters:
# * "metadata.owner" returns Services that have a label with the key "owner"
# this is the same as "metadata:owner".
# * "metadata.protocol=gRPC" returns Services that have key/value
# "protocol=gRPC".
# * "name>projects/my-project/locations/us-east/namespaces/my-namespace/services/service-c"
# returns Services that have name that is alphabetically later than the
# string, so "service-e" will be returned but "service-a" will not be.
# * "metadata.owner!=sd AND metadata.foo=bar" returns Services that have
# "owner" in label key but value is not "sd" AND have key/value foo=bar.
# * "doesnotexist.foo=bar" returns an empty list. Note that Service doesn't
# have a field called "doesnotexist". Since the filter does not match any
# Services, it returns no results.
# @param order_by [String]
# Optional. The order to list result by.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Gapic::PagedEnumerable<Google::Cloud::ServiceDirectory::V1beta1::Service>]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Gapic::PagedEnumerable<Google::Cloud::ServiceDirectory::V1beta1::Service>]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def list_services request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Cloud::ServiceDirectory::V1beta1::ListServicesRequest
# 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_services.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::ServiceDirectory::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_services.timeout,
metadata: metadata,
retry_policy: @config.rpcs.list_services.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@registration_service_stub.call_rpc :list_services, request, options: options do |response, operation|
response = Gapic::PagedEnumerable.new @registration_service_stub, :list_services, 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
##
# Gets a service.
#
# @overload get_service(request, options = nil)
# @param request [Google::Cloud::ServiceDirectory::V1beta1::GetServiceRequest | Hash]
# Gets a service.
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload get_service(name: nil)
# @param name [String]
# Required. The name of the service to get.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Google::Cloud::ServiceDirectory::V1beta1::Service]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Google::Cloud::ServiceDirectory::V1beta1::Service]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def get_service request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Cloud::ServiceDirectory::V1beta1::GetServiceRequest
# 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_service.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::ServiceDirectory::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_service.timeout,
metadata: metadata,
retry_policy: @config.rpcs.get_service.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@registration_service_stub.call_rpc :get_service, 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
##
# Updates a service.
#
# @overload update_service(request, options = nil)
# @param request [Google::Cloud::ServiceDirectory::V1beta1::UpdateServiceRequest | Hash]
# Updates a service.
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload update_service(service: nil, update_mask: nil)
# @param service [Google::Cloud::ServiceDirectory::V1beta1::Service | Hash]
# Required. The updated service.
# @param update_mask [Google::Protobuf::FieldMask | Hash]
# Required. List of fields to be updated in this request.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Google::Cloud::ServiceDirectory::V1beta1::Service]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Google::Cloud::ServiceDirectory::V1beta1::Service]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def update_service request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Cloud::ServiceDirectory::V1beta1::UpdateServiceRequest
# 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_service.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::ServiceDirectory::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {
"service.name" => request.service.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_service.timeout,
metadata: metadata,
retry_policy: @config.rpcs.update_service.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@registration_service_stub.call_rpc :update_service, 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
##
# Deletes a service. This also deletes all endpoints associated with
# the service.
#
# @overload delete_service(request, options = nil)
# @param request [Google::Cloud::ServiceDirectory::V1beta1::DeleteServiceRequest | Hash]
# Deletes a service. This also deletes all endpoints associated with
# the service.
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload delete_service(name: nil)
# @param name [String]
# Required. The name of the service to delete.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Google::Protobuf::Empty]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Google::Protobuf::Empty]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def delete_service request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Cloud::ServiceDirectory::V1beta1::DeleteServiceRequest
# 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_service.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::ServiceDirectory::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_service.timeout,
metadata: metadata,
retry_policy: @config.rpcs.delete_service.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@registration_service_stub.call_rpc :delete_service, 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
##
# Creates a endpoint, and returns the new Endpoint.
#
# @overload create_endpoint(request, options = nil)
# @param request [Google::Cloud::ServiceDirectory::V1beta1::CreateEndpointRequest | Hash]
# Creates a endpoint, and returns the new Endpoint.
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload create_endpoint(parent: nil, endpoint_id: nil, endpoint: nil)
# @param parent [String]
# Required. The resource name of the service that this endpoint provides.
# @param endpoint_id [String]
# Required. The Resource ID must be 1-63 characters long, and comply with
# <a href="https://www.ietf.org/rfc/rfc1035.txt" target="_blank">RFC1035</a>.
# Specifically, the name must be 1-63 characters long and match the regular
# expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?` which means the first
# character must be a lowercase letter, and all following characters must
# be a dash, lowercase letter, or digit, except the last character, which
# cannot be a dash.
# @param endpoint [Google::Cloud::ServiceDirectory::V1beta1::Endpoint | Hash]
# Required. A endpoint with initial fields set.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Google::Cloud::ServiceDirectory::V1beta1::Endpoint]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Google::Cloud::ServiceDirectory::V1beta1::Endpoint]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def create_endpoint request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Cloud::ServiceDirectory::V1beta1::CreateEndpointRequest
# 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_endpoint.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::ServiceDirectory::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_endpoint.timeout,
metadata: metadata,
retry_policy: @config.rpcs.create_endpoint.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@registration_service_stub.call_rpc :create_endpoint, 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
##
# Lists all endpoints.
#
# @overload list_endpoints(request, options = nil)
# @param request [Google::Cloud::ServiceDirectory::V1beta1::ListEndpointsRequest | Hash]
# Lists all endpoints.
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload list_endpoints(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
# @param parent [String]
# Required. The resource name of the service whose endpoints we'd like to
# list.
# @param page_size [Integer]
# Optional. The maximum number of items to return.
# @param page_token [String]
# Optional. The next_page_token value returned from a previous List request,
# if any.
# @param filter [String]
# Optional. The filter to list result by.
#
# General filter string syntax:
# <field> <operator> <value> (<logical connector>)
# <field> can be "name", "address", "port" or "metadata.<key>" for map field.
# <operator> can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS, and
# is roughly the same as "=".
# <value> must be the same data type as field.
# <logical connector> can be "AND, OR, NOT".
#
# Examples of valid filters:
# * "metadata.owner" returns Endpoints that have a label with the key "owner"
# this is the same as "metadata:owner".
# * "metadata.protocol=gRPC" returns Endpoints that have key/value
# "protocol=gRPC".
# * "address=192.108.1.105" returns Endpoints that have this address.
# * "port>8080" returns Endpoints that have port number larger than 8080.
# * "name>projects/my-project/locations/us-east/namespaces/my-namespace/services/my-service/endpoints/endpoint-c"
# returns Endpoints that have name that is alphabetically later than the
# string, so "endpoint-e" will be returned but "endpoint-a" will not be.
# * "metadata.owner!=sd AND metadata.foo=bar" returns Endpoints that have
# "owner" in label key but value is not "sd" AND have key/value foo=bar.
# * "doesnotexist.foo=bar" returns an empty list. Note that Endpoint doesn't
# have a field called "doesnotexist". Since the filter does not match any
# Endpoints, it returns no results.
# @param order_by [String]
# Optional. The order to list result by.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Gapic::PagedEnumerable<Google::Cloud::ServiceDirectory::V1beta1::Endpoint>]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Gapic::PagedEnumerable<Google::Cloud::ServiceDirectory::V1beta1::Endpoint>]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def list_endpoints request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Cloud::ServiceDirectory::V1beta1::ListEndpointsRequest
# 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_endpoints.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::ServiceDirectory::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_endpoints.timeout,
metadata: metadata,
retry_policy: @config.rpcs.list_endpoints.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@registration_service_stub.call_rpc :list_endpoints, request, options: options do |response, operation|
response = Gapic::PagedEnumerable.new @registration_service_stub, :list_endpoints, 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
##
# Gets a endpoint.
#
# @overload get_endpoint(request, options = nil)
# @param request [Google::Cloud::ServiceDirectory::V1beta1::GetEndpointRequest | Hash]
# Gets a endpoint.
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload get_endpoint(name: nil)
# @param name [String]
# Required. The name of the endpoint to get.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Google::Cloud::ServiceDirectory::V1beta1::Endpoint]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Google::Cloud::ServiceDirectory::V1beta1::Endpoint]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def get_endpoint request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Cloud::ServiceDirectory::V1beta1::GetEndpointRequest
# 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_endpoint.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::ServiceDirectory::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_endpoint.timeout,
metadata: metadata,
retry_policy: @config.rpcs.get_endpoint.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@registration_service_stub.call_rpc :get_endpoint, 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
##
# Updates a endpoint.
#
# @overload update_endpoint(request, options = nil)
# @param request [Google::Cloud::ServiceDirectory::V1beta1::UpdateEndpointRequest | Hash]
# Updates a endpoint.
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload update_endpoint(endpoint: nil, update_mask: nil)
# @param endpoint [Google::Cloud::ServiceDirectory::V1beta1::Endpoint | Hash]
# Required. The updated endpoint.
# @param update_mask [Google::Protobuf::FieldMask | Hash]
# Required. List of fields to be updated in this request.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Google::Cloud::ServiceDirectory::V1beta1::Endpoint]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Google::Cloud::ServiceDirectory::V1beta1::Endpoint]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def update_endpoint request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Cloud::ServiceDirectory::V1beta1::UpdateEndpointRequest
# 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_endpoint.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::ServiceDirectory::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {
"endpoint.name" => request.endpoint.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_endpoint.timeout,
metadata: metadata,
retry_policy: @config.rpcs.update_endpoint.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@registration_service_stub.call_rpc :update_endpoint, 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
##
# Deletes a endpoint.
#
# @overload delete_endpoint(request, options = nil)
# @param request [Google::Cloud::ServiceDirectory::V1beta1::DeleteEndpointRequest | Hash]
# Deletes a endpoint.
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload delete_endpoint(name: nil)
# @param name [String]
# Required. The name of the endpoint to delete.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Google::Protobuf::Empty]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Google::Protobuf::Empty]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def delete_endpoint request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Cloud::ServiceDirectory::V1beta1::DeleteEndpointRequest
# 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_endpoint.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::ServiceDirectory::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_endpoint.timeout,
metadata: metadata,
retry_policy: @config.rpcs.delete_endpoint.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@registration_service_stub.call_rpc :delete_endpoint, 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
##
# Gets the IAM Policy for a resource (namespace or service only).
#
# @overload get_iam_policy(request, options = nil)
# @param request [Google::Iam::V1::GetIamPolicyRequest | Hash]
# Gets the IAM Policy for a resource (namespace or service only).
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload get_iam_policy(resource: nil)
# @param resource [String]
# REQUIRED: The resource for which the policy is being requested.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/{project}`.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Google::Iam::V1::Policy]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Google::Iam::V1::Policy]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def get_iam_policy request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Iam::V1::GetIamPolicyRequest
# 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_iam_policy.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::ServiceDirectory::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {
"resource" => request.resource
}
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_iam_policy.timeout,
metadata: metadata,
retry_policy: @config.rpcs.get_iam_policy.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@registration_service_stub.call_rpc :get_iam_policy, 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
##
# Sets the IAM Policy for a resource (namespace or service only).
#
# @overload set_iam_policy(request, options = nil)
# @param request [Google::Iam::V1::SetIamPolicyRequest | Hash]
# Sets the IAM Policy for a resource (namespace or service only).
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload set_iam_policy(resource: nil, policy: nil)
# @param resource [String]
# REQUIRED: The resource for which the policy is being specified.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/{project}`.
# @param policy [Google::Iam::V1::Policy | Hash]
# REQUIRED: The complete policy to be applied to the `resource`. The size of
# the policy is limited to a few 10s of KB. An empty policy is a
# valid policy but certain Cloud Platform services (such as Projects)
# might reject them.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Google::Iam::V1::Policy]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Google::Iam::V1::Policy]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def set_iam_policy request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Iam::V1::SetIamPolicyRequest
# 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.set_iam_policy.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::ServiceDirectory::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {
"resource" => request.resource
}
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.set_iam_policy.timeout,
metadata: metadata,
retry_policy: @config.rpcs.set_iam_policy.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@registration_service_stub.call_rpc :set_iam_policy, 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
##
# Tests IAM permissions for a resource (namespace or service only).
#
# @overload test_iam_permissions(request, options = nil)
# @param request [Google::Iam::V1::TestIamPermissionsRequest | Hash]
# Tests IAM permissions for a resource (namespace or service only).
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload test_iam_permissions(resource: nil, permissions: nil)
# @param resource [String]
# REQUIRED: The resource for which the policy detail is being requested.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/{project}`.
# @param permissions [Array<String>]
# The set of permissions to check for the `resource`. Permissions with
# wildcards (such as '*' or 'storage.*') are not allowed. For more
# information see
# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Google::Iam::V1::TestIamPermissionsResponse]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Google::Iam::V1::TestIamPermissionsResponse]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def test_iam_permissions request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Iam::V1::TestIamPermissionsRequest
# 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.test_iam_permissions.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::ServiceDirectory::V1beta1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {
"resource" => request.resource
}
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.test_iam_permissions.timeout,
metadata: metadata,
retry_policy: @config.rpcs.test_iam_permissions.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@registration_service_stub.call_rpc :test_iam_permissions, 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
##
# Configuration class for the RegistrationService API.
#
# This class represents the configuration for RegistrationService,
# providing control over timeouts, retry behavior, logging, transport
# parameters, and other low-level controls. Certain parameters can also be
# applied individually to specific RPCs. See
# {Google::Cloud::ServiceDirectory::V1beta1::RegistrationService::Client::Configuration::Rpcs}
# for a list of RPCs that can be configured independently.
#
# Configuration can be applied globally to all clients, or to a single client
# on construction.
#
# # Examples
#
# To modify the global config, setting the timeout for create_namespace
# to 20 seconds, and all remaining timeouts to 10 seconds:
#
# Google::Cloud::ServiceDirectory::V1beta1::RegistrationService::Client.configure do |config|
# config.timeout = 10_000
# config.rpcs.create_namespace.timeout = 20_000
# end
#
# To apply the above configuration only to a new client:
#
# client = Google::Cloud::ServiceDirectory::V1beta1::RegistrationService::Client.new do |config|
# config.timeout = 10_000
# config.rpcs.create_namespace.timeout = 20_000
# end
#
# @!attribute [rw] endpoint
# The hostname or hostname:port of the service endpoint.
# Defaults to `"servicedirectory.googleapis.com"`.
# @return [String]
# @!attribute [rw] credentials
# Credentials to send with calls. You may provide any of the following types:
# * (`String`) The path to a service account key file in JSON format
# * (`Hash`) A service account key as a Hash
# * (`Google::Auth::Credentials`) A googleauth credentials object
# (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
# (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
# * (`nil`) indicating no credentials
# @return [Object]
# @!attribute [rw] scope
# The OAuth scopes
# @return [Array<String>]
# @!attribute [rw] lib_name
# The library name as recorded in instrumentation and logging
# @return [String]
# @!attribute [rw] lib_version
# The library version as recorded in instrumentation and logging
# @return [String]
# @!attribute [rw] channel_args
# Extra parameters passed to the gRPC channel. Note: this is ignored if a
# `GRPC::Core::Channel` object is provided as the credential.
# @return [Hash]
# @!attribute [rw] interceptors
# An array of interceptors that are run before calls are executed.
# @return [Array<GRPC::ClientInterceptor>]
# @!attribute [rw] timeout
# The call timeout in milliseconds.
# @return [Numeric]
# @!attribute [rw] metadata
# Additional gRPC headers to be sent with the call.
# @return [Hash{Symbol=>String}]
# @!attribute [rw] retry_policy
# The retry policy. The value is a hash with the following keys:
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
# trigger a retry.
# @return [Hash]
#
class Configuration
extend Gapic::Config
config_attr :endpoint, "servicedirectory.googleapis.com", String
config_attr :credentials, nil do |value|
allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
allowed.any? { |klass| klass === value }
end
config_attr :scope, nil, String, Array, nil
config_attr :lib_name, nil, String, nil
config_attr :lib_version, nil, String, nil
config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, Hash, nil)
config_attr :interceptors, nil, Array, nil
config_attr :timeout, nil, Numeric, nil
config_attr :metadata, nil, Hash, nil
config_attr :retry_policy, nil, Hash, Proc, nil
# @private
def initialize parent_config = nil
@parent_config = parent_config unless parent_config.nil?
yield self if block_given?
end
##
# Configurations for individual RPCs
# @return [Rpcs]
#
def rpcs
@rpcs ||= begin
parent_rpcs = nil
parent_rpcs = @parent_config.rpcs if @parent_config&.respond_to? :rpcs
Rpcs.new parent_rpcs
end
end
##
# Configuration RPC class for the RegistrationService API.
#
# Includes fields providing the configuration for each RPC in this service.
# Each configuration object is of type `Gapic::Config::Method` and includes
# the following configuration fields:
#
# * `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
# include the following keys:
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
# trigger a retry.
#
class Rpcs
##
# RPC-specific configuration for `create_namespace`
# @return [Gapic::Config::Method]
#
attr_reader :create_namespace
##
# RPC-specific configuration for `list_namespaces`
# @return [Gapic::Config::Method]
#
attr_reader :list_namespaces
##
# RPC-specific configuration for `get_namespace`
# @return [Gapic::Config::Method]
#
attr_reader :get_namespace
##
# RPC-specific configuration for `update_namespace`
# @return [Gapic::Config::Method]
#
attr_reader :update_namespace
##
# RPC-specific configuration for `delete_namespace`
# @return [Gapic::Config::Method]
#
attr_reader :delete_namespace
##
# RPC-specific configuration for `create_service`
# @return [Gapic::Config::Method]
#
attr_reader :create_service
##
# RPC-specific configuration for `list_services`
# @return [Gapic::Config::Method]
#
attr_reader :list_services
##
# RPC-specific configuration for `get_service`
# @return [Gapic::Config::Method]
#
attr_reader :get_service
##
# RPC-specific configuration for `update_service`
# @return [Gapic::Config::Method]
#
attr_reader :update_service
##
# RPC-specific configuration for `delete_service`
# @return [Gapic::Config::Method]
#
attr_reader :delete_service
##
# RPC-specific configuration for `create_endpoint`
# @return [Gapic::Config::Method]
#
attr_reader :create_endpoint
##
# RPC-specific configuration for `list_endpoints`
# @return [Gapic::Config::Method]
#
attr_reader :list_endpoints
##
# RPC-specific configuration for `get_endpoint`
# @return [Gapic::Config::Method]
#
attr_reader :get_endpoint
##
# RPC-specific configuration for `update_endpoint`
# @return [Gapic::Config::Method]
#
attr_reader :update_endpoint
##
# RPC-specific configuration for `delete_endpoint`
# @return [Gapic::Config::Method]
#
attr_reader :delete_endpoint
##
# RPC-specific configuration for `get_iam_policy`
# @return [Gapic::Config::Method]
#
attr_reader :get_iam_policy
##
# RPC-specific configuration for `set_iam_policy`
# @return [Gapic::Config::Method]
#
attr_reader :set_iam_policy
##
# RPC-specific configuration for `test_iam_permissions`
# @return [Gapic::Config::Method]
#
attr_reader :test_iam_permissions
# @private
def initialize parent_rpcs = nil
create_namespace_config = parent_rpcs&.create_namespace if parent_rpcs&.respond_to? :create_namespace
@create_namespace = Gapic::Config::Method.new create_namespace_config
list_namespaces_config = parent_rpcs&.list_namespaces if parent_rpcs&.respond_to? :list_namespaces
@list_namespaces = Gapic::Config::Method.new list_namespaces_config
get_namespace_config = parent_rpcs&.get_namespace if parent_rpcs&.respond_to? :get_namespace
@get_namespace = Gapic::Config::Method.new get_namespace_config
update_namespace_config = parent_rpcs&.update_namespace if parent_rpcs&.respond_to? :update_namespace
@update_namespace = Gapic::Config::Method.new update_namespace_config
delete_namespace_config = parent_rpcs&.delete_namespace if parent_rpcs&.respond_to? :delete_namespace
@delete_namespace = Gapic::Config::Method.new delete_namespace_config
create_service_config = parent_rpcs&.create_service if parent_rpcs&.respond_to? :create_service
@create_service = Gapic::Config::Method.new create_service_config
list_services_config = parent_rpcs&.list_services if parent_rpcs&.respond_to? :list_services
@list_services = Gapic::Config::Method.new list_services_config
get_service_config = parent_rpcs&.get_service if parent_rpcs&.respond_to? :get_service
@get_service = Gapic::Config::Method.new get_service_config
update_service_config = parent_rpcs&.update_service if parent_rpcs&.respond_to? :update_service
@update_service = Gapic::Config::Method.new update_service_config
delete_service_config = parent_rpcs&.delete_service if parent_rpcs&.respond_to? :delete_service
@delete_service = Gapic::Config::Method.new delete_service_config
create_endpoint_config = parent_rpcs&.create_endpoint if parent_rpcs&.respond_to? :create_endpoint
@create_endpoint = Gapic::Config::Method.new create_endpoint_config
list_endpoints_config = parent_rpcs&.list_endpoints if parent_rpcs&.respond_to? :list_endpoints
@list_endpoints = Gapic::Config::Method.new list_endpoints_config
get_endpoint_config = parent_rpcs&.get_endpoint if parent_rpcs&.respond_to? :get_endpoint
@get_endpoint = Gapic::Config::Method.new get_endpoint_config
update_endpoint_config = parent_rpcs&.update_endpoint if parent_rpcs&.respond_to? :update_endpoint
@update_endpoint = Gapic::Config::Method.new update_endpoint_config
delete_endpoint_config = parent_rpcs&.delete_endpoint if parent_rpcs&.respond_to? :delete_endpoint
@delete_endpoint = Gapic::Config::Method.new delete_endpoint_config
get_iam_policy_config = parent_rpcs&.get_iam_policy if parent_rpcs&.respond_to? :get_iam_policy
@get_iam_policy = Gapic::Config::Method.new get_iam_policy_config
set_iam_policy_config = parent_rpcs&.set_iam_policy if parent_rpcs&.respond_to? :set_iam_policy
@set_iam_policy = Gapic::Config::Method.new set_iam_policy_config
test_iam_permissions_config = parent_rpcs&.test_iam_permissions if parent_rpcs&.respond_to? :test_iam_permissions
@test_iam_permissions = Gapic::Config::Method.new test_iam_permissions_config
yield self if block_given?
end
end
end
end
end
end
end
end
end
# rubocop:disable Lint/HandleExceptions
# Once client is loaded, load helpers.rb if it exists.
begin
require "google/cloud/service_directory/v1beta1/registration_service/helpers"
rescue LoadError
end
# rubocop:enable Lint/HandleExceptions