class Google::Apis::DomainsrdapV1::DomainsRDAPService

Domains RDAP API

Read-only public API that lets users search for information about domain names.

@example

require 'google/apis/domainsrdap_v1'

Domainsrdap = Google::Apis::DomainsrdapV1 # Alias the module
service = Domainsrdap::DomainsRDAPService.new

@see developers.google.com/domains/rdap/

Attributes

key[RW]

@return [String]

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.
quota_user[RW]

@return [String]

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.

Public Class Methods

new() click to toggle source
Calls superclass method
# File lib/google/apis/domainsrdap_v1/service.rb, line 45
def initialize
  super('https://domainsrdap.googleapis.com/', '',
        client_name: 'google-apis-domainsrdap_v1',
        client_version: Google::Apis::DomainsrdapV1::GEM_VERSION)
  @batch_path = 'batch'
end

Public Instance Methods

get_autnum(autnum_id, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error. @param [String] autnum_id @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DomainsrdapV1::RdapResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DomainsrdapV1::RdapResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/domainsrdap_v1/service.rb, line 72
def get_autnum(autnum_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/autnum/{autnumId}', options)
  command.response_representation = Google::Apis::DomainsrdapV1::RdapResponse::Representation
  command.response_class = Google::Apis::DomainsrdapV1::RdapResponse
  command.params['autnumId'] = autnum_id unless autnum_id.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_domain(domain_name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Look up RDAP information for a domain by name. @param [String] domain_name

Full domain name to look up. Example: "example.com"

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DomainsrdapV1::HttpBody] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DomainsrdapV1::HttpBody]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/domainsrdap_v1/service.rb, line 102
def get_domain(domain_name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/domain/{+domainName}', options)
  command.response_representation = Google::Apis::DomainsrdapV1::HttpBody::Representation
  command.response_class = Google::Apis::DomainsrdapV1::HttpBody
  command.params['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
get_domains(fields: nil, quota_user: nil, options: nil, &block) click to toggle source

The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error. @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DomainsrdapV1::RdapResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DomainsrdapV1::RdapResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/domainsrdap_v1/service.rb, line 223
def get_domains(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/domains', options)
  command.response_representation = Google::Apis::DomainsrdapV1::RdapResponse::Representation
  command.response_class = Google::Apis::DomainsrdapV1::RdapResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
get_entities(fields: nil, quota_user: nil, options: nil, &block) click to toggle source

The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error. @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DomainsrdapV1::RdapResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DomainsrdapV1::RdapResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/domainsrdap_v1/service.rb, line 251
def get_entities(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/entities', options)
  command.response_representation = Google::Apis::DomainsrdapV1::RdapResponse::Representation
  command.response_class = Google::Apis::DomainsrdapV1::RdapResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
get_entity(entity_id, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error. @param [String] entity_id @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DomainsrdapV1::RdapResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DomainsrdapV1::RdapResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/domainsrdap_v1/service.rb, line 132
def get_entity(entity_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/entity/{entityId}', options)
  command.response_representation = Google::Apis::DomainsrdapV1::RdapResponse::Representation
  command.response_class = Google::Apis::DomainsrdapV1::RdapResponse
  command.params['entityId'] = entity_id unless entity_id.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_help(fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Get help information for the RDAP API, including links to documentation. @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DomainsrdapV1::HttpBody] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DomainsrdapV1::HttpBody]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/domainsrdap_v1/service.rb, line 278
def get_help(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/help', options)
  command.response_representation = Google::Apis::DomainsrdapV1::HttpBody::Representation
  command.response_class = Google::Apis::DomainsrdapV1::HttpBody
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
get_ip(fields: nil, quota_user: nil, options: nil, &block) click to toggle source

The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error. @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DomainsrdapV1::HttpBody] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DomainsrdapV1::HttpBody]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/domainsrdap_v1/service.rb, line 306
def get_ip(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/ip', options)
  command.response_representation = Google::Apis::DomainsrdapV1::HttpBody::Representation
  command.response_class = Google::Apis::DomainsrdapV1::HttpBody
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
get_nameserver(nameserver_id, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error. @param [String] nameserver_id @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DomainsrdapV1::RdapResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DomainsrdapV1::RdapResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/domainsrdap_v1/service.rb, line 194
def get_nameserver(nameserver_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/nameserver/{nameserverId}', options)
  command.response_representation = Google::Apis::DomainsrdapV1::RdapResponse::Representation
  command.response_class = Google::Apis::DomainsrdapV1::RdapResponse
  command.params['nameserverId'] = nameserver_id unless nameserver_id.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_nameservers(fields: nil, quota_user: nil, options: nil, &block) click to toggle source

The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error. @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DomainsrdapV1::RdapResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DomainsrdapV1::RdapResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/domainsrdap_v1/service.rb, line 334
def get_nameservers(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/nameservers', options)
  command.response_representation = Google::Apis::DomainsrdapV1::RdapResponse::Representation
  command.response_class = Google::Apis::DomainsrdapV1::RdapResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
ip_get(ip_id, ip_id1, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error. @param [String] ip_id @param [String] ip_id1 @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DomainsrdapV1::RdapResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DomainsrdapV1::RdapResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/domainsrdap_v1/service.rb, line 163
def ip_get(ip_id, ip_id1, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/ip/{ipId}/{ipId1}', options)
  command.response_representation = Google::Apis::DomainsrdapV1::RdapResponse::Representation
  command.response_class = Google::Apis::DomainsrdapV1::RdapResponse
  command.params['ipId'] = ip_id unless ip_id.nil?
  command.params['ipId1'] = ip_id1 unless ip_id1.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

Protected Instance Methods

apply_command_defaults(command) click to toggle source
# File lib/google/apis/domainsrdap_v1/service.rb, line 345
def apply_command_defaults(command)
  command.query['key'] = key unless key.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
end