class Google::Cloud::Gaming::V1::RealmsService::Client
Client
for the RealmsService
service.
A realm is a grouping of game server clusters that are considered interchangeable.
Attributes
Get the associated client for long-running operations.
@return [::Google::Cloud::Gaming::V1::RealmsService::Operations]
@private
Public Class Methods
Configure the RealmsService
Client
class.
See {::Google::Cloud::Gaming::V1::RealmsService::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all RealmsService clients ::Google::Cloud::Gaming::V1::RealmsService::Client.configure do |config| config.timeout = 10.0 end
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/gaming/v1/realms_service/client.rb, line 57 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Gaming", "V1"] 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.rpcs.list_realms.timeout = 60.0 default_config.rpcs.list_realms.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.get_realm.timeout = 60.0 default_config.rpcs.get_realm.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.create_realm.timeout = 60.0 default_config.rpcs.delete_realm.timeout = 60.0 default_config.rpcs.update_realm.timeout = 60.0 default_config.rpcs.preview_realm_update.timeout = 60.0 default_config.rpcs.preview_realm_update.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config end yield @configure if block_given? @configure end
Create a new RealmsService
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::Gaming::V1::RealmsService::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Gaming::V1::RealmsService::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the RealmsService
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/gaming/v1/realms_service/client.rb, line 131 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/gaming/v1/realms_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 # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = Operations.new do |config| config.credentials = credentials config.endpoint = @config.endpoint end @realms_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Gaming::V1::RealmsService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
Configure the RealmsService
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::Gaming::V1::RealmsService::Client::Configuration} for a description of the configuration fields.
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/gaming/v1/realms_service/client.rb, line 110 def configure yield @config if block_given? @config end
Creates a new realm in a given project and location.
@overload create_realm
(request, options = nil)
Pass arguments to `create_realm` via a request object, either of type {::Google::Cloud::Gaming::V1::CreateRealmRequest} or an equivalent Hash. @param request [::Google::Cloud::Gaming::V1::CreateRealmRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload create_realm
(parent: nil, realm_id: nil, realm: nil)
Pass arguments to `create_realm` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param parent [::String] Required. The parent resource name, in the following form: `projects/{project}/locations/{location}`. @param realm_id [::String] Required. The ID of the realm resource to be created. @param realm [::Google::Cloud::Gaming::V1::Realm, ::Hash] Required. The realm resource to be created.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/gaming/v1/realms_service/client.rb, line 368 def create_realm request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::CreateRealmRequest # 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_realm.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::Gaming::V1::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_realm.timeout, metadata: metadata, retry_policy: @config.rpcs.create_realm.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @realms_service_stub.call_rpc :create_realm, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Deletes a single realm.
@overload delete_realm
(request, options = nil)
Pass arguments to `delete_realm` via a request object, either of type {::Google::Cloud::Gaming::V1::DeleteRealmRequest} or an equivalent Hash. @param request [::Google::Cloud::Gaming::V1::DeleteRealmRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload delete_realm
(name: nil)
Pass arguments to `delete_realm` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param name [::String] Required. The name of the realm to delete, in the following form: `projects/{project}/locations/{location}/realms/{realm}`.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/gaming/v1/realms_service/client.rb, line 438 def delete_realm request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::DeleteRealmRequest # 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_realm.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::Gaming::V1::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_realm.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_realm.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @realms_service_stub.call_rpc :delete_realm, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Gets details of a single realm.
@overload get_realm
(request, options = nil)
Pass arguments to `get_realm` via a request object, either of type {::Google::Cloud::Gaming::V1::GetRealmRequest} or an equivalent Hash. @param request [::Google::Cloud::Gaming::V1::GetRealmRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_realm
(name: nil)
Pass arguments to `get_realm` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param name [::String] Required. The name of the realm to retrieve, in the following form: `projects/{project}/locations/{location}/realms/{realm}`.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Gaming::V1::Realm] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Gaming::V1::Realm]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/gaming/v1/realms_service/client.rb, line 295 def get_realm request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::GetRealmRequest # 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_realm.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::Gaming::V1::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_realm.timeout, metadata: metadata, retry_policy: @config.rpcs.get_realm.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @realms_service_stub.call_rpc :get_realm, 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 realms in a given project and location.
@overload list_realms
(request, options = nil)
Pass arguments to `list_realms` via a request object, either of type {::Google::Cloud::Gaming::V1::ListRealmsRequest} or an equivalent Hash. @param request [::Google::Cloud::Gaming::V1::ListRealmsRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload list_realms
(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
Pass arguments to `list_realms` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param parent [::String] Required. The parent resource name, in the following form: `projects/{project}/locations/{location}`. @param page_size [::Integer] Optional. The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's {::Google::Cloud::Gaming::V1::ListRealmsResponse#next_page_token next_page_token} to determine if there are more realms left to be queried. @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 apply to list results. @param order_by [::String] Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Gaming::V1::Realm>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::Gaming::V1::Realm>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/gaming/v1/realms_service/client.rb, line 225 def list_realms request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::ListRealmsRequest # 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_realms.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::Gaming::V1::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_realms.timeout, metadata: metadata, retry_policy: @config.rpcs.list_realms.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @realms_service_stub.call_rpc :list_realms, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @realms_service_stub, :list_realms, 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
Previews patches to a single realm.
@overload preview_realm_update
(request, options = nil)
Pass arguments to `preview_realm_update` via a request object, either of type {::Google::Cloud::Gaming::V1::PreviewRealmUpdateRequest} or an equivalent Hash. @param request [::Google::Cloud::Gaming::V1::PreviewRealmUpdateRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload preview_realm_update
(realm: nil, update_mask: nil, preview_time: nil)
Pass arguments to `preview_realm_update` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param realm [::Google::Cloud::Gaming::V1::Realm, ::Hash] Required. The realm to be updated. Only fields specified in update_mask are updated. @param update_mask [::Google::Protobuf::FieldMask, ::Hash] Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask @param preview_time [::Google::Protobuf::Timestamp, ::Hash] Optional. The target timestamp to compute the preview.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Gaming::V1::PreviewRealmUpdateResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Gaming::V1::PreviewRealmUpdateResponse]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/gaming/v1/realms_service/client.rb, line 588 def preview_realm_update request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::PreviewRealmUpdateRequest # 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.preview_realm_update.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::Gaming::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "realm.name" => request.realm.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.preview_realm_update.timeout, metadata: metadata, retry_policy: @config.rpcs.preview_realm_update.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @realms_service_stub.call_rpc :preview_realm_update, 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
Patches a single realm.
@overload update_realm
(request, options = nil)
Pass arguments to `update_realm` via a request object, either of type {::Google::Cloud::Gaming::V1::UpdateRealmRequest} or an equivalent Hash. @param request [::Google::Cloud::Gaming::V1::UpdateRealmRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload update_realm
(realm: nil, update_mask: nil)
Pass arguments to `update_realm` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param realm [::Google::Cloud::Gaming::V1::Realm, ::Hash] Required. The realm to be updated. Only fields specified in update_mask are updated. @param update_mask [::Google::Protobuf::FieldMask, ::Hash] Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/gaming/v1/realms_service/client.rb, line 512 def update_realm request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::UpdateRealmRequest # 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_realm.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::Gaming::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "realm.name" => request.realm.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_realm.timeout, metadata: metadata, retry_policy: @config.rpcs.update_realm.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @realms_service_stub.call_rpc :update_realm, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end