Class: Google::Apis::DomainsrdapV1::DomainsRDAPService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/domainsrdap_v1/service.rb

Overview

Domains RDAP API

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

Examples:

require 'google/apis/domainsrdap_v1'

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

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://domainsrdap.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ DomainsRDAPService

Returns a new instance of DomainsRDAPService.



47
48
49
50
51
52
 
# File 'lib/google/apis/domainsrdap_v1/service.rb', line 47

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-domainsrdap_v1',
        client_version: Google::Apis::DomainsrdapV1::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.

Returns:

  • (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.



40
41
42
 
# File 'lib/google/apis/domainsrdap_v1/service.rb', line 40

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.

Returns:

  • (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.



45
46
47
 
# File 'lib/google/apis/domainsrdap_v1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#get_autnum(autnum_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DomainsrdapV1::RdapResponse

The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.

Parameters:

  • autnum_id (String)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



74
75
76
77
78
79
80
81
82
 
# File 'lib/google/apis/domainsrdap_v1/service.rb', line 74

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) {|result, err| ... } ⇒ Google::Apis::DomainsrdapV1::HttpBody

Look up RDAP information for a domain by name.

Parameters:

  • domain_name (String) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



104
105
106
107
108
109
110
111
112
 
# File 'lib/google/apis/domainsrdap_v1/service.rb', line 104

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) {|result, err| ... } ⇒ Google::Apis::DomainsrdapV1::RdapResponse

The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.

Parameters:

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



225
226
227
228
229
230
231
232
 
# File 'lib/google/apis/domainsrdap_v1/service.rb', line 225

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) {|result, err| ... } ⇒ Google::Apis::DomainsrdapV1::RdapResponse

The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.

Parameters:

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



253
254
255
256
257
258
259
260
 
# File 'lib/google/apis/domainsrdap_v1/service.rb', line 253

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) {|result, err| ... } ⇒ Google::Apis::DomainsrdapV1::RdapResponse

The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.

Parameters:

  • entity_id (String)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



134
135
136
137
138
139
140
141
142
 
# File 'lib/google/apis/domainsrdap_v1/service.rb', line 134

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) {|result, err| ... } ⇒ Google::Apis::DomainsrdapV1::HttpBody

Get help information for the RDAP API, including links to documentation.

Parameters:

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



280
281
282
283
284
285
286
287
 
# File 'lib/google/apis/domainsrdap_v1/service.rb', line 280

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) {|result, err| ... } ⇒ Google::Apis::DomainsrdapV1::HttpBody

The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.

Parameters:

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



308
309
310
311
312
313
314
315
 
# File 'lib/google/apis/domainsrdap_v1/service.rb', line 308

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) {|result, err| ... } ⇒ Google::Apis::DomainsrdapV1::RdapResponse

The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.

Parameters:

  • nameserver_id (String)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



196
197
198
199
200
201
202
203
204
 
# File 'lib/google/apis/domainsrdap_v1/service.rb', line 196

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) {|result, err| ... } ⇒ Google::Apis::DomainsrdapV1::RdapResponse

The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.

Parameters:

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



336
337
338
339
340
341
342
343
 
# File 'lib/google/apis/domainsrdap_v1/service.rb', line 336

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) {|result, err| ... } ⇒ Google::Apis::DomainsrdapV1::RdapResponse

The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.

Parameters:

  • ip_id (String)
  • ip_id1 (String)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



165
166
167
168
169
170
171
172
173
174
 
# File 'lib/google/apis/domainsrdap_v1/service.rb', line 165

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