Class: Google::Cloud::AppEngine::V1::DomainMappings::Rest::Client
- Inherits:
-
Object
- Object
- Google::Cloud::AppEngine::V1::DomainMappings::Rest::Client
- Defined in:
- lib/google/cloud/app_engine/v1/domain_mappings/rest/client.rb
Overview
REST client for the DomainMappings service.
Manages domains serving an application.
Defined Under Namespace
Classes: Configuration
Instance Attribute Summary collapse
-
#operations_client ⇒ ::Google::Cloud::AppEngine::V1::DomainMappings::Rest::Operations
readonly
Get the associated client for long-running operations.
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the DomainMappings Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the DomainMappings Client instance.
-
#create_domain_mapping(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Operation
Maps a domain to an application.
-
#delete_domain_mapping(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Operation
Deletes the specified domain mapping.
-
#get_domain_mapping(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::AppEngine::V1::DomainMapping
Gets the specified domain mapping.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new DomainMappings REST client object.
-
#list_domain_mappings(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AppEngine::V1::DomainMapping>
Lists the domain mappings on an application.
-
#universe_domain ⇒ String
The effective universe domain.
-
#update_domain_mapping(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Operation
Updates the specified domain mapping.
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new DomainMappings REST client object.
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'lib/google/cloud/app_engine/v1/domain_mappings/rest/client.rb', line 121 def initialize # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint.nil? || (@config.endpoint == Configuration::DEFAULT_ENDPOINT && !@config.endpoint.split(".").first.include?("-")) credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = ::Google::Cloud::AppEngine::V1::DomainMappings::Rest::Operations.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint config.universe_domain = @config.universe_domain end @domain_mappings_stub = ::Google::Cloud::AppEngine::V1::DomainMappings::Rest::ServiceStub.new( endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, credentials: credentials ) end |
Instance Attribute Details
#operations_client ⇒ ::Google::Cloud::AppEngine::V1::DomainMappings::Rest::Operations (readonly)
Get the associated client for long-running operations.
164 165 166 |
# File 'lib/google/cloud/app_engine/v1/domain_mappings/rest/client.rb', line 164 def operations_client @operations_client end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the DomainMappings Client class.
See Configuration for a description of the configuration fields.
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
# File 'lib/google/cloud/app_engine/v1/domain_mappings/rest/client.rb', line 59 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 |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
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 configure.
See Configuration for a description of the configuration fields.
91 92 93 94 |
# File 'lib/google/cloud/app_engine/v1/domain_mappings/rest/client.rb', line 91 def configure yield @config if block_given? @config end |
#create_domain_mapping(request, options = nil) ⇒ ::Gapic::Operation #create_domain_mapping(parent: nil, domain_mapping: nil, override_strategy: nil) ⇒ ::Gapic::Operation
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
.
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 |
# File 'lib/google/cloud/app_engine/v1/domain_mappings/rest/client.rb', line 391 def create_domain_mapping request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.create_domain_mapping..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.create_domain_mapping.timeout, metadata: , retry_policy: @config.rpcs.create_domain_mapping.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @domain_mappings_stub.create_domain_mapping request, do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#delete_domain_mapping(request, options = nil) ⇒ ::Gapic::Operation #delete_domain_mapping(name: nil) ⇒ ::Gapic::Operation
Deletes the specified domain mapping. A user must be authorized to
administer the associated domain in order to delete a DomainMapping
resource.
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 |
# File 'lib/google/cloud/app_engine/v1/domain_mappings/rest/client.rb', line 575 def delete_domain_mapping request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.delete_domain_mapping..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.delete_domain_mapping.timeout, metadata: , retry_policy: @config.rpcs.delete_domain_mapping.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @domain_mappings_stub.delete_domain_mapping request, do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#get_domain_mapping(request, options = nil) ⇒ ::Google::Cloud::AppEngine::V1::DomainMapping #get_domain_mapping(name: nil) ⇒ ::Google::Cloud::AppEngine::V1::DomainMapping
Gets the specified domain mapping.
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 |
# File 'lib/google/cloud/app_engine/v1/domain_mappings/rest/client.rb', line 299 def get_domain_mapping request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_domain_mapping..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.get_domain_mapping.timeout, metadata: , retry_policy: @config.rpcs.get_domain_mapping.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @domain_mappings_stub.get_domain_mapping request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#list_domain_mappings(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AppEngine::V1::DomainMapping> #list_domain_mappings(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AppEngine::V1::DomainMapping>
Lists the domain mappings on an application.
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
# File 'lib/google/cloud/app_engine/v1/domain_mappings/rest/client.rb', line 219 def list_domain_mappings request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_domain_mappings..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.list_domain_mappings.timeout, metadata: , retry_policy: @config.rpcs.list_domain_mappings.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @domain_mappings_stub.list_domain_mappings request, do |result, operation| result = ::Gapic::Rest::PagedEnumerable.new @domain_mappings_stub, :list_domain_mappings, "domain_mappings", request, result, yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#universe_domain ⇒ String
The effective universe domain
101 102 103 |
# File 'lib/google/cloud/app_engine/v1/domain_mappings/rest/client.rb', line 101 def universe_domain @domain_mappings_stub.universe_domain end |
#update_domain_mapping(request, options = nil) ⇒ ::Gapic::Operation #update_domain_mapping(name: nil, domain_mapping: nil, update_mask: nil) ⇒ ::Gapic::Operation
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.
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 |
# File 'lib/google/cloud/app_engine/v1/domain_mappings/rest/client.rb', line 486 def update_domain_mapping request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.update_domain_mapping..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.update_domain_mapping.timeout, metadata: , retry_policy: @config.rpcs.update_domain_mapping.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @domain_mappings_stub.update_domain_mapping request, do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |