class Google::Cloud::AppEngine::V1::DomainMappings::Client
Client
for the DomainMappings
service.
Manages domains serving an application.
Attributes
@private
Get the associated client for long-running operations.
@return [::Google::Cloud::AppEngine::V1::DomainMappings::Operations]
Public Class Methods
Configure the DomainMappings
Client
class.
See {::Google::Cloud::AppEngine::V1::DomainMappings::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all DomainMappings clients ::Google::Cloud::AppEngine::V1::DomainMappings::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/app_engine/v1/domain_mappings/client.rb, line 54 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "AppEngine", "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 end yield @configure if block_given? @configure end
Create a new DomainMappings
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::AppEngine::V1::DomainMappings::Client.new # Create a client using a custom configuration client = ::Google::Cloud::AppEngine::V1::DomainMappings::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the DomainMappings
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/app_engine/v1/domain_mappings/client.rb, line 107 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/appengine/v1/appengine_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 @domain_mappings_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::AppEngine::V1::DomainMappings::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
Configure the DomainMappings
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::AppEngine::V1::DomainMappings::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/app_engine/v1/domain_mappings/client.rb, line 86 def configure yield @config if block_given? @config end
Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see [`AuthorizedDomains.ListAuthorizedDomains`]().
@overload create_domain_mapping
(request, options = nil)
Pass arguments to `create_domain_mapping` via a request object, either of type {::Google::Cloud::AppEngine::V1::CreateDomainMappingRequest} or an equivalent Hash. @param request [::Google::Cloud::AppEngine::V1::CreateDomainMappingRequest, ::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_domain_mapping
(parent: nil, domain_mapping: nil, override_strategy: nil)
Pass arguments to `create_domain_mapping` 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] Name of the parent Application resource. Example: `apps/myapp`. @param domain_mapping [::Google::Cloud::AppEngine::V1::DomainMapping, ::Hash] Domain mapping configuration. @param override_strategy [::Google::Cloud::AppEngine::V1::DomainOverrideStrategy] Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.
@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/app_engine/v1/domain_mappings/client.rb, line 335 def create_domain_mapping request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AppEngine::V1::CreateDomainMappingRequest # 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_domain_mapping.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::AppEngine::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_domain_mapping.timeout, metadata: metadata, retry_policy: @config.rpcs.create_domain_mapping.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @domain_mappings_stub.call_rpc :create_domain_mapping, 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 the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a `DomainMapping` resource.
@overload delete_domain_mapping
(request, options = nil)
Pass arguments to `delete_domain_mapping` via a request object, either of type {::Google::Cloud::AppEngine::V1::DeleteDomainMappingRequest} or an equivalent Hash. @param request [::Google::Cloud::AppEngine::V1::DeleteDomainMappingRequest, ::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_domain_mapping
(name: nil)
Pass arguments to `delete_domain_mapping` 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] Name of the resource to delete. Example: `apps/myapp/domainMappings/example.com`.
@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/app_engine/v1/domain_mappings/client.rb, line 485 def delete_domain_mapping request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AppEngine::V1::DeleteDomainMappingRequest # 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_domain_mapping.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::AppEngine::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_domain_mapping.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_domain_mapping.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @domain_mappings_stub.call_rpc :delete_domain_mapping, 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 the specified domain mapping.
@overload get_domain_mapping
(request, options = nil)
Pass arguments to `get_domain_mapping` via a request object, either of type {::Google::Cloud::AppEngine::V1::GetDomainMappingRequest} or an equivalent Hash. @param request [::Google::Cloud::AppEngine::V1::GetDomainMappingRequest, ::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_domain_mapping
(name: nil)
Pass arguments to `get_domain_mapping` 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] Name of the resource requested. Example: `apps/myapp/domainMappings/example.com`.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::AppEngine::V1::DomainMapping] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::AppEngine::V1::DomainMapping]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/app_engine/v1/domain_mappings/client.rb, line 260 def get_domain_mapping request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AppEngine::V1::GetDomainMappingRequest # 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_domain_mapping.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::AppEngine::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_domain_mapping.timeout, metadata: metadata, retry_policy: @config.rpcs.get_domain_mapping.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @domain_mappings_stub.call_rpc :get_domain_mapping, 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 the domain mappings on an application.
@overload list_domain_mappings
(request, options = nil)
Pass arguments to `list_domain_mappings` via a request object, either of type {::Google::Cloud::AppEngine::V1::ListDomainMappingsRequest} or an equivalent Hash. @param request [::Google::Cloud::AppEngine::V1::ListDomainMappingsRequest, ::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_domain_mappings
(parent: nil, page_size: nil, page_token: nil)
Pass arguments to `list_domain_mappings` 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] Name of the parent Application resource. Example: `apps/myapp`. @param page_size [::Integer] Maximum results to return per page. @param page_token [::String] Continuation token for fetching the next page of results.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::AppEngine::V1::DomainMapping>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::AppEngine::V1::DomainMapping>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/app_engine/v1/domain_mappings/client.rb, line 190 def list_domain_mappings request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AppEngine::V1::ListDomainMappingsRequest # 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_domain_mappings.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::AppEngine::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_domain_mappings.timeout, metadata: metadata, retry_policy: @config.rpcs.list_domain_mappings.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @domain_mappings_stub.call_rpc :list_domain_mappings, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @domain_mappings_stub, :list_domain_mappings, 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
Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update `certificate_id` to point to an `AuthorizedCertificate` resource. A user must be authorized to administer the associated domain in order to update a `DomainMapping` resource.
@overload update_domain_mapping
(request, options = nil)
Pass arguments to `update_domain_mapping` via a request object, either of type {::Google::Cloud::AppEngine::V1::UpdateDomainMappingRequest} or an equivalent Hash. @param request [::Google::Cloud::AppEngine::V1::UpdateDomainMappingRequest, ::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_domain_mapping
(name: nil, domain_mapping: nil, update_mask: nil)
Pass arguments to `update_domain_mapping` 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] Name of the resource to update. Example: `apps/myapp/domainMappings/example.com`. @param domain_mapping [::Google::Cloud::AppEngine::V1::DomainMapping, ::Hash] A domain mapping containing the updated resource. Only fields set in the field mask will be updated. @param update_mask [::Google::Protobuf::FieldMask, ::Hash] Standard field mask for the set of fields to be updated.
@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/app_engine/v1/domain_mappings/client.rb, line 413 def update_domain_mapping request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AppEngine::V1::UpdateDomainMappingRequest # 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_domain_mapping.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::AppEngine::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.update_domain_mapping.timeout, metadata: metadata, retry_policy: @config.rpcs.update_domain_mapping.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @domain_mappings_stub.call_rpc :update_domain_mapping, 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