Class: Google::Apis::DomainsV1alpha2::CloudDomainsService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::DomainsV1alpha2::CloudDomainsService
- Defined in:
- lib/google/apis/domains_v1alpha2/service.rb
Overview
Cloud Domains API
Enables management and configuration of domain names.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Instance Method Summary collapse
-
#configure_registration_contact_settings(registration, configure_contact_settings_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::Operation
Updates a
Registration
's contact settings. -
#configure_registration_dns_settings(registration, configure_dns_settings_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::Operation
Updates a
Registration
's DNS settings. -
#configure_registration_management_settings(registration, configure_management_settings_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::Operation
Updates a
Registration
's management settings. -
#delete_project_location_registration(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::Operation
Deletes a
Registration
resource. -
#export_registration(name, export_registration_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::Operation
Exports a
Registration
that you no longer want to use with Cloud Domains. -
#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::Location
Gets information about a location.
-
#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::Operation
Gets the latest state of a long-running operation.
-
#get_project_location_registration(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::Registration
Gets the details of a
Registration
resource. -
#get_project_location_registration_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::Policy
Gets the access control policy for a resource.
-
#initialize ⇒ CloudDomainsService
constructor
A new instance of CloudDomainsService.
-
#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::ListOperationsResponse
Lists operations that match the specified filter in the request.
-
#list_project_location_registrations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::ListRegistrationsResponse
Lists the
Registration
resources in a project. -
#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::ListLocationsResponse
Lists information about the supported locations for this service.
-
#patch_project_location_registration(name, registration_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::Operation
Updates select fields of a
Registration
resource, notablylabels
. -
#register_registration_domain(parent, register_domain_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::Operation
Registers a new domain name and creates a corresponding
Registration
resource. -
#reset_registration_authorization_code(registration, reset_authorization_code_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::AuthorizationCode
Resets the authorization code of the
Registration
to a new random string. -
#retrieve_project_location_registration_authorization_code(registration, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::AuthorizationCode
Gets the authorization code of the
Registration
for the purpose of transferring the domain to another registrar. -
#retrieve_project_location_registration_register_parameters(location, domain_name: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::RetrieveRegisterParametersResponse
Gets parameters needed to register a new domain name, including price and up- to-date availability.
-
#search_project_location_registration_domains(location, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::SearchDomainsResponse
Searches for available domain names similar to the provided query.
-
#set_registration_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::Policy
Sets the access control policy on the specified resource.
-
#test_registration_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::TestIamPermissionsResponse
Returns permissions that a caller has on the specified resource.
Constructor Details
#initialize ⇒ CloudDomainsService
Returns a new instance of CloudDomainsService.
45 46 47 48 49 50 |
# File 'lib/google/apis/domains_v1alpha2/service.rb', line 45 def initialize super('https://domains.googleapis.com/', '', client_name: 'google-apis-domains_v1alpha2', client_version: Google::Apis::DomainsV1alpha2::GEM_VERSION) @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
38 39 40 |
# File 'lib/google/apis/domains_v1alpha2/service.rb', line 38 def key @key end |
#quota_user ⇒ String
Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
43 44 45 |
# File 'lib/google/apis/domains_v1alpha2/service.rb', line 43 def quota_user @quota_user end |
Instance Method Details
#configure_registration_contact_settings(registration, configure_contact_settings_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::Operation
Updates a Registration
's contact settings. Some changes require confirmation
by the domain's registrant contact .
225 226 227 228 229 230 231 232 233 234 235 |
# File 'lib/google/apis/domains_v1alpha2/service.rb', line 225 def configure_registration_contact_settings(registration, configure_contact_settings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1alpha2/{+registration}:configureContactSettings', ) command.request_representation = Google::Apis::DomainsV1alpha2::ConfigureContactSettingsRequest::Representation command.request_object = configure_contact_settings_request_object command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation command.response_class = Google::Apis::DomainsV1alpha2::Operation command.params['registration'] = registration unless registration.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#configure_registration_dns_settings(registration, configure_dns_settings_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::Operation
Updates a Registration
's DNS settings.
259 260 261 262 263 264 265 266 267 268 269 |
# File 'lib/google/apis/domains_v1alpha2/service.rb', line 259 def configure_registration_dns_settings(registration, configure_dns_settings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1alpha2/{+registration}:configureDnsSettings', ) command.request_representation = Google::Apis::DomainsV1alpha2::ConfigureDnsSettingsRequest::Representation command.request_object = configure_dns_settings_request_object command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation command.response_class = Google::Apis::DomainsV1alpha2::Operation command.params['registration'] = registration unless registration.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#configure_registration_management_settings(registration, configure_management_settings_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::Operation
Updates a Registration
's management settings.
293 294 295 296 297 298 299 300 301 302 303 |
# File 'lib/google/apis/domains_v1alpha2/service.rb', line 293 def configure_registration_management_settings(registration, configure_management_settings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1alpha2/{+registration}:configureManagementSettings', ) command.request_representation = Google::Apis::DomainsV1alpha2::ConfigureManagementSettingsRequest::Representation command.request_object = configure_management_settings_request_object command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation command.response_class = Google::Apis::DomainsV1alpha2::Operation command.params['registration'] = registration unless registration.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_location_registration(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::Operation
Deletes a Registration
resource. This method only works on resources in one
of the following states: * state
is EXPORTED
with expire_time
in the
past * state
is REGISTRATION_FAILED
328 329 330 331 332 333 334 335 336 |
# File 'lib/google/apis/domains_v1alpha2/service.rb', line 328 def delete_project_location_registration(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1alpha2/{+name}', ) command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation command.response_class = Google::Apis::DomainsV1alpha2::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#export_registration(name, export_registration_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::Operation
Exports a Registration
that you no longer want to use with Cloud Domains.
You can continue to use the domain in Google Domains
until it expires. If the export is successful: * The resource's state
becomes EXPORTED
, meaning that it is no longer managed by Cloud Domains *
Because individual users can own domains in Google Domains, the calling user
becomes the domain's sole owner. Permissions for the domain are subsequently
managed in Google Domains. * Without further action, the domain does not renew
automatically. The new owner can set up billing in Google Domains to renew the
domain if needed.
368 369 370 371 372 373 374 375 376 377 378 |
# File 'lib/google/apis/domains_v1alpha2/service.rb', line 368 def export_registration(name, export_registration_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1alpha2/{+name}:export', ) command.request_representation = Google::Apis::DomainsV1alpha2::ExportRegistrationRequest::Representation command.request_object = export_registration_request_object command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation command.response_class = Google::Apis::DomainsV1alpha2::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::Location
Gets information about a location.
72 73 74 75 76 77 78 79 80 |
# File 'lib/google/apis/domains_v1alpha2/service.rb', line 72 def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha2/{+name}', ) command.response_representation = Google::Apis::DomainsV1alpha2::Location::Representation command.response_class = Google::Apis::DomainsV1alpha2::Location command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::Operation
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
146 147 148 149 150 151 152 153 154 |
# File 'lib/google/apis/domains_v1alpha2/service.rb', line 146 def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha2/{+name}', ) command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation command.response_class = Google::Apis::DomainsV1alpha2::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_registration(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::Registration
Gets the details of a Registration
resource.
401 402 403 404 405 406 407 408 409 |
# File 'lib/google/apis/domains_v1alpha2/service.rb', line 401 def get_project_location_registration(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha2/{+name}', ) command.response_representation = Google::Apis::DomainsV1alpha2::Registration::Representation command.response_class = Google::Apis::DomainsV1alpha2::Registration command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_registration_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::Policy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
441 442 443 444 445 446 447 448 449 450 |
# File 'lib/google/apis/domains_v1alpha2/service.rb', line 441 def get_project_location_registration_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha2/{+resource}:getIamPolicy', ) command.response_representation = Google::Apis::DomainsV1alpha2::Policy::Representation command.response_class = Google::Apis::DomainsV1alpha2::Policy command.params['resource'] = resource unless resource.nil? command.query['options.requestedPolicyVersion'] = unless .nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::ListOperationsResponse
Lists operations that match the specified filter in the request. If the server
doesn't support this method, it returns UNIMPLEMENTED
. NOTE: the name
binding allows API services to override the binding to use different resource
name schemes, such as users/*/operations
. To override the binding, API
services can add a binding such as "/v1/
name=users/*/operations"
to their
service configuration. For backwards compatibility, the default name includes
the operations collection id, however overriding users must ensure the name
binding is the parent resource, without the operations collection id.
189 190 191 192 193 194 195 196 197 198 199 200 |
# File 'lib/google/apis/domains_v1alpha2/service.rb', line 189 def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha2/{+name}/operations', ) command.response_representation = Google::Apis::DomainsV1alpha2::ListOperationsResponse::Representation command.response_class = Google::Apis::DomainsV1alpha2::ListOperationsResponse command.params['name'] = name unless name.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_registrations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::ListRegistrationsResponse
Lists the Registration
resources in a project.
490 491 492 493 494 495 496 497 498 499 500 501 |
# File 'lib/google/apis/domains_v1alpha2/service.rb', line 490 def list_project_location_registrations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha2/{+parent}/registrations', ) command.response_representation = Google::Apis::DomainsV1alpha2::ListRegistrationsResponse::Representation command.response_class = Google::Apis::DomainsV1alpha2::ListRegistrationsResponse command.params['parent'] = parent unless parent.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::ListLocationsResponse
Lists information about the supported locations for this service.
112 113 114 115 116 117 118 119 120 121 122 123 |
# File 'lib/google/apis/domains_v1alpha2/service.rb', line 112 def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha2/{+name}/locations', ) command.response_representation = Google::Apis::DomainsV1alpha2::ListLocationsResponse::Representation command.response_class = Google::Apis::DomainsV1alpha2::ListLocationsResponse command.params['name'] = name unless name.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_project_location_registration(name, registration_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::Operation
Updates select fields of a Registration
resource, notably labels
. To
update other fields, use the appropriate custom update method: * To update
management settings, see ConfigureManagementSettings
* To update DNS
configuration, see ConfigureDnsSettings
* To update contact information, see
ConfigureContactSettings
533 534 535 536 537 538 539 540 541 542 543 544 |
# File 'lib/google/apis/domains_v1alpha2/service.rb', line 533 def patch_project_location_registration(name, registration_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1alpha2/{+name}', ) command.request_representation = Google::Apis::DomainsV1alpha2::Registration::Representation command.request_object = registration_object command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation command.response_class = Google::Apis::DomainsV1alpha2::Operation command.params['name'] = name unless name.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#register_registration_domain(parent, register_domain_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::Operation
Registers a new domain name and creates a corresponding Registration
resource. Call RetrieveRegisterParameters
first to check availability of the
domain name and determine parameters like price that are needed to build a
call to this method. A successful call creates a Registration
resource in
state REGISTRATION_PENDING
, which resolves to ACTIVE
within 1-2 minutes,
indicating that the domain was successfully registered. If the resource ends
up in state REGISTRATION_FAILED
, it indicates that the domain was not
registered successfully, and you can safely delete the resource and retry
registration.
576 577 578 579 580 581 582 583 584 585 586 |
# File 'lib/google/apis/domains_v1alpha2/service.rb', line 576 def register_registration_domain(parent, register_domain_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1alpha2/{+parent}/registrations:register', ) command.request_representation = Google::Apis::DomainsV1alpha2::RegisterDomainRequest::Representation command.request_object = register_domain_request_object command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation command.response_class = Google::Apis::DomainsV1alpha2::Operation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#reset_registration_authorization_code(registration, reset_authorization_code_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::AuthorizationCode
Resets the authorization code of the Registration
to a new random string.
You can call this method only after 60 days have elapsed since the initial
domain registration.
612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/apis/domains_v1alpha2/service.rb', line 612 def (registration, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1alpha2/{+registration}:resetAuthorizationCode', ) command.request_representation = Google::Apis::DomainsV1alpha2::ResetAuthorizationCodeRequest::Representation command.request_object = command.response_representation = Google::Apis::DomainsV1alpha2::AuthorizationCode::Representation command.response_class = Google::Apis::DomainsV1alpha2::AuthorizationCode command.params['registration'] = registration unless registration.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#retrieve_project_location_registration_authorization_code(registration, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::AuthorizationCode
Gets the authorization code of the Registration
for the purpose of
transferring the domain to another registrar. You can call this method only
after 60 days have elapsed since the initial domain registration.
647 648 649 650 651 652 653 654 655 |
# File 'lib/google/apis/domains_v1alpha2/service.rb', line 647 def (registration, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha2/{+registration}:retrieveAuthorizationCode', ) command.response_representation = Google::Apis::DomainsV1alpha2::AuthorizationCode::Representation command.response_class = Google::Apis::DomainsV1alpha2::AuthorizationCode command.params['registration'] = registration unless registration.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#retrieve_project_location_registration_register_parameters(location, domain_name: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::RetrieveRegisterParametersResponse
Gets parameters needed to register a new domain name, including price and up-
to-date availability. Use the returned values to call RegisterDomain
.
681 682 683 684 685 686 687 688 689 690 |
# File 'lib/google/apis/domains_v1alpha2/service.rb', line 681 def retrieve_project_location_registration_register_parameters(location, domain_name: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha2/{+location}/registrations:retrieveRegisterParameters', ) command.response_representation = Google::Apis::DomainsV1alpha2::RetrieveRegisterParametersResponse::Representation command.response_class = Google::Apis::DomainsV1alpha2::RetrieveRegisterParametersResponse command.params['location'] = location unless location.nil? command.query['domainName'] = domain_name unless domain_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#search_project_location_registration_domains(location, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::SearchDomainsResponse
Searches for available domain names similar to the provided query.
Availability results from this method are approximate; call
RetrieveRegisterParameters
on a domain before registering to confirm
availability.
717 718 719 720 721 722 723 724 725 726 |
# File 'lib/google/apis/domains_v1alpha2/service.rb', line 717 def search_project_location_registration_domains(location, query: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha2/{+location}/registrations:searchDomains', ) command.response_representation = Google::Apis::DomainsV1alpha2::SearchDomainsResponse::Representation command.response_class = Google::Apis::DomainsV1alpha2::SearchDomainsResponse command.params['location'] = location unless location.nil? command.query['query'] = query unless query.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#set_registration_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::Policy
Sets the access control policy on the specified resource. Replaces any
existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and
PERMISSION_DENIED
errors.
752 753 754 755 756 757 758 759 760 761 762 |
# File 'lib/google/apis/domains_v1alpha2/service.rb', line 752 def set_registration_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1alpha2/{+resource}:setIamPolicy', ) command.request_representation = Google::Apis::DomainsV1alpha2::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::DomainsV1alpha2::Policy::Representation command.response_class = Google::Apis::DomainsV1alpha2::Policy command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#test_registration_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsV1alpha2::TestIamPermissionsResponse
Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of permissions, not a
NOT_FOUND
error. Note: This operation is designed to be used for building
permission-aware UIs and command-line tools, not for authorization checking.
This operation may "fail open" without warning.
790 791 792 793 794 795 796 797 798 799 800 |
# File 'lib/google/apis/domains_v1alpha2/service.rb', line 790 def (resource, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1alpha2/{+resource}:testIamPermissions', ) command.request_representation = Google::Apis::DomainsV1alpha2::TestIamPermissionsRequest::Representation command.request_object = command.response_representation = Google::Apis::DomainsV1alpha2::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::DomainsV1alpha2::TestIamPermissionsResponse command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |