Class: Google::Apis::DnsV1::DnsService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/dns_v1/service.rb

Overview

Google Cloud DNS API

Configures and serves authoritative DNS records.

Examples:

require 'google/apis/dns_v1'

Dns = Google::Apis::DnsV1 # Alias the module
service = Dns::DnsService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ DnsService

Returns a new instance of DnsService



51
52
53
54
 
# File 'generated/google/apis/dns_v1/service.rb', line 51

def initialize
  super('https://www.googleapis.com/', 'dns/v1/projects/')
  @batch_path = 'batch/dns/v1'
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.



38
39
40
 
# File 'generated/google/apis/dns_v1/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. Overrides userIp if both are provided.

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. Overrides userIp if both are provided.



44
45
46
 
# File 'generated/google/apis/dns_v1/service.rb', line 44

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns:

  • (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.



49
50
51
 
# File 'generated/google/apis/dns_v1/service.rb', line 49

def user_ip
  @user_ip
end

Instance Method Details

#create_change(project, managed_zone, change_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV1::Change

Atomically update the ResourceRecordSet collection.

Parameters:

  • project (String) —

    Identifies the project addressed by this request.

  • managed_zone (String) —

    Identifies the managed zone addressed by this request. Can be the managed zone name or id.

  • change_object (Google::Apis::DnsV1::Change) (defaults to: nil)
  • client_operation_id (String) —

    For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'generated/google/apis/dns_v1/service.rb', line 87

def create_change(project, managed_zone, change_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{project}/managedZones/{managedZone}/changes', options)
  command.request_representation = Google::Apis::DnsV1::Change::Representation
  command.request_object = change_object
  command.response_representation = Google::Apis::DnsV1::Change::Representation
  command.response_class = Google::Apis::DnsV1::Change
  command.params['project'] = project unless project.nil?
  command.params['managedZone'] = managed_zone unless managed_zone.nil?
  command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#create_managed_zone(project, managed_zone_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV1::ManagedZone

Create a new ManagedZone.

Parameters:

  • project (String) —

    Identifies the project addressed by this request.

  • managed_zone_object (Google::Apis::DnsV1::ManagedZone) (defaults to: nil)
  • client_operation_id (String) —

    For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'generated/google/apis/dns_v1/service.rb', line 427

def create_managed_zone(project, managed_zone_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{project}/managedZones', options)
  command.request_representation = Google::Apis::DnsV1::ManagedZone::Representation
  command.request_object = managed_zone_object
  command.response_representation = Google::Apis::DnsV1::ManagedZone::Representation
  command.response_class = Google::Apis::DnsV1::ManagedZone
  command.params['project'] = project unless project.nil?
  command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_managed_zone(project, managed_zone, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Delete a previously created ManagedZone.

Parameters:

  • project (String) —

    Identifies the project addressed by this request.

  • managed_zone (String) —

    Identifies the managed zone addressed by this request. Can be the managed zone name or id.

  • client_operation_id (String) —

    For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



471
472
473
474
475
476
477
478
479
480
 
# File 'generated/google/apis/dns_v1/service.rb', line 471

def delete_managed_zone(project, managed_zone, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '{project}/managedZones/{managedZone}', options)
  command.params['project'] = project unless project.nil?
  command.params['managedZone'] = managed_zone unless managed_zone.nil?
  command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_change(project, managed_zone, change_id, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV1::Change

Fetch the representation of an existing Change.

Parameters:

  • project (String) —

    Identifies the project addressed by this request.

  • managed_zone (String) —

    Identifies the managed zone addressed by this request. Can be the managed zone name or id.

  • change_id (String) —

    The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse.

  • client_operation_id (String) —

    For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'generated/google/apis/dns_v1/service.rb', line 135

def get_change(project, managed_zone, change_id, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/managedZones/{managedZone}/changes/{changeId}', options)
  command.response_representation = Google::Apis::DnsV1::Change::Representation
  command.response_class = Google::Apis::DnsV1::Change
  command.params['project'] = project unless project.nil?
  command.params['managedZone'] = managed_zone unless managed_zone.nil?
  command.params['changeId'] = change_id unless change_id.nil?
  command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_dns_key(project, managed_zone, dns_key_id, client_operation_id: nil, digest_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV1::DnsKey

Fetch the representation of an existing DnsKey.

Parameters:

  • project (String) —

    Identifies the project addressed by this request.

  • managed_zone (String) —

    Identifies the managed zone addressed by this request. Can be the managed zone name or id.

  • dns_key_id (String) —

    The identifier of the requested DnsKey.

  • client_operation_id (String) —

    For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.

  • digest_type (String) —

    An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'generated/google/apis/dns_v1/service.rb', line 238

def get_dns_key(project, managed_zone, dns_key_id, client_operation_id: nil, digest_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/managedZones/{managedZone}/dnsKeys/{dnsKeyId}', options)
  command.response_representation = Google::Apis::DnsV1::DnsKey::Representation
  command.response_class = Google::Apis::DnsV1::DnsKey
  command.params['project'] = project unless project.nil?
  command.params['managedZone'] = managed_zone unless managed_zone.nil?
  command.params['dnsKeyId'] = dns_key_id unless dns_key_id.nil?
  command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil?
  command.query['digestType'] = digest_type unless digest_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_managed_zone(project, managed_zone, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV1::ManagedZone

Fetch the representation of an existing ManagedZone.

Parameters:

  • project (String) —

    Identifies the project addressed by this request.

  • managed_zone (String) —

    Identifies the managed zone addressed by this request. Can be the managed zone name or id.

  • client_operation_id (String) —

    For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'generated/google/apis/dns_v1/service.rb', line 512

def get_managed_zone(project, managed_zone, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/managedZones/{managedZone}', options)
  command.response_representation = Google::Apis::DnsV1::ManagedZone::Representation
  command.response_class = Google::Apis::DnsV1::ManagedZone
  command.params['project'] = project unless project.nil?
  command.params['managedZone'] = managed_zone unless managed_zone.nil?
  command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_managed_zone_operation(project, managed_zone, operation, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV1::Operation

Fetch the representation of an existing Operation.

Parameters:

  • project (String) —

    Identifies the project addressed by this request.

  • managed_zone (String) —

    Identifies the managed zone addressed by this request.

  • operation (String) —

    Identifies the operation addressed by this request.

  • client_operation_id (String) —

    For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'generated/google/apis/dns_v1/service.rb', line 336

def get_managed_zone_operation(project, managed_zone, operation, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/managedZones/{managedZone}/operations/{operation}', options)
  command.response_representation = Google::Apis::DnsV1::Operation::Representation
  command.response_class = Google::Apis::DnsV1::Operation
  command.params['project'] = project unless project.nil?
  command.params['managedZone'] = managed_zone unless managed_zone.nil?
  command.params['operation'] = operation unless operation.nil?
  command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_project(project, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV1::Project

Fetch the representation of an existing Project.

Parameters:

  • project (String) —

    Identifies the project addressed by this request.

  • client_operation_id (String) —

    For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



690
691
692
693
694
695
696
697
698
699
700
 
# File 'generated/google/apis/dns_v1/service.rb', line 690

def get_project(project, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}', options)
  command.response_representation = Google::Apis::DnsV1::Project::Representation
  command.response_class = Google::Apis::DnsV1::Project
  command.params['project'] = project unless project.nil?
  command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_changes(project, managed_zone, max_results: nil, page_token: nil, sort_by: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV1::ListChangesResponse

Enumerate Changes to a ResourceRecordSet collection.

Parameters:

  • project (String) —

    Identifies the project addressed by this request.

  • managed_zone (String) —

    Identifies the managed zone addressed by this request. Can be the managed zone name or id.

  • max_results (Fixnum) —

    Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.

  • page_token (String) —

    Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.

  • sort_by (String) —

    Sorting criterion. The only supported value is change sequence.

  • sort_order (String) —

    Sorting order direction: 'ascending' or 'descending'.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'generated/google/apis/dns_v1/service.rb', line 186

def list_changes(project, managed_zone, max_results: nil, page_token: nil, sort_by: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/managedZones/{managedZone}/changes', options)
  command.response_representation = Google::Apis::DnsV1::ListChangesResponse::Representation
  command.response_class = Google::Apis::DnsV1::ListChangesResponse
  command.params['project'] = project unless project.nil?
  command.params['managedZone'] = managed_zone unless managed_zone.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['sortBy'] = sort_by unless sort_by.nil?
  command.query['sortOrder'] = sort_order unless sort_order.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_dns_keys(project, managed_zone, digest_type: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV1::DnsKeysListResponse

Enumerate DnsKeys to a ResourceRecordSet collection.

Parameters:

  • project (String) —

    Identifies the project addressed by this request.

  • managed_zone (String) —

    Identifies the managed zone addressed by this request. Can be the managed zone name or id.

  • digest_type (String) —

    An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed.

  • max_results (Fixnum) —

    Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.

  • page_token (String) —

    Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'generated/google/apis/dns_v1/service.rb', line 290

def list_dns_keys(project, managed_zone, digest_type: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/managedZones/{managedZone}/dnsKeys', options)
  command.response_representation = Google::Apis::DnsV1::DnsKeysListResponse::Representation
  command.response_class = Google::Apis::DnsV1::DnsKeysListResponse
  command.params['project'] = project unless project.nil?
  command.params['managedZone'] = managed_zone unless managed_zone.nil?
  command.query['digestType'] = digest_type unless digest_type.nil?
  command.query['maxResults'] = max_results unless max_results.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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_managed_zone_operations(project, managed_zone, max_results: nil, page_token: nil, sort_by: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV1::ManagedZoneOperationsListResponse

Enumerate Operations for the given ManagedZone.

Parameters:

  • project (String) —

    Identifies the project addressed by this request.

  • managed_zone (String) —

    Identifies the managed zone addressed by this request.

  • max_results (Fixnum) —

    Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.

  • page_token (String) —

    Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.

  • sort_by (String) —

    Sorting criterion. The only supported values are START_TIME and ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'generated/google/apis/dns_v1/service.rb', line 384

def list_managed_zone_operations(project, managed_zone, max_results: nil, page_token: nil, sort_by: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/managedZones/{managedZone}/operations', options)
  command.response_representation = Google::Apis::DnsV1::ManagedZoneOperationsListResponse::Representation
  command.response_class = Google::Apis::DnsV1::ManagedZoneOperationsListResponse
  command.params['project'] = project unless project.nil?
  command.params['managedZone'] = managed_zone unless managed_zone.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['sortBy'] = sort_by unless sort_by.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_managed_zones(project, dns_name: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV1::ListManagedZonesResponse

Enumerate ManagedZones that have been created but not yet deleted.

Parameters:

  • project (String) —

    Identifies the project addressed by this request.

  • dns_name (String) —

    Restricts the list to return only zones with this domain name.

  • max_results (Fixnum) —

    Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.

  • page_token (String) —

    Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



557
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'generated/google/apis/dns_v1/service.rb', line 557

def list_managed_zones(project, dns_name: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/managedZones', options)
  command.response_representation = Google::Apis::DnsV1::ListManagedZonesResponse::Representation
  command.response_class = Google::Apis::DnsV1::ListManagedZonesResponse
  command.params['project'] = project unless project.nil?
  command.query['dnsName'] = dns_name unless dns_name.nil?
  command.query['maxResults'] = max_results unless max_results.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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_resource_record_sets(project, managed_zone, max_results: nil, name: nil, page_token: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV1::ListResourceRecordSetsResponse

Enumerate ResourceRecordSets that have been created but not yet deleted.

Parameters:

  • project (String) —

    Identifies the project addressed by this request.

  • managed_zone (String) —

    Identifies the managed zone addressed by this request. Can be the managed zone name or id.

  • max_results (Fixnum) —

    Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.

  • name (String) —

    Restricts the list to return only records with this fully qualified domain name.

  • page_token (String) —

    Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.

  • type (String) —

    Restricts the list to return only records of this type. If present, the "name" parameter must also be present.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
 
# File 'generated/google/apis/dns_v1/service.rb', line 741

def list_resource_record_sets(project, managed_zone, max_results: nil, name: nil, page_token: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/managedZones/{managedZone}/rrsets', options)
  command.response_representation = Google::Apis::DnsV1::ListResourceRecordSetsResponse::Representation
  command.response_class = Google::Apis::DnsV1::ListResourceRecordSetsResponse
  command.params['project'] = project unless project.nil?
  command.params['managedZone'] = managed_zone unless managed_zone.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['name'] = name unless name.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['type'] = type unless type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_managed_zone(project, managed_zone, managed_zone_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV1::Operation

Update an existing ManagedZone. This method supports patch semantics.

Parameters:

  • project (String) —

    Identifies the project addressed by this request.

  • managed_zone (String) —

    Identifies the managed zone addressed by this request. Can be the managed zone name or id.

  • managed_zone_object (Google::Apis::DnsV1::ManagedZone) (defaults to: nil)
  • client_operation_id (String) —

    For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



602
603
604
605
606
607
608
609
610
611
612
613
614
615
 
# File 'generated/google/apis/dns_v1/service.rb', line 602

def patch_managed_zone(project, managed_zone, managed_zone_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '{project}/managedZones/{managedZone}', options)
  command.request_representation = Google::Apis::DnsV1::ManagedZone::Representation
  command.request_object = managed_zone_object
  command.response_representation = Google::Apis::DnsV1::Operation::Representation
  command.response_class = Google::Apis::DnsV1::Operation
  command.params['project'] = project unless project.nil?
  command.params['managedZone'] = managed_zone unless managed_zone.nil?
  command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_managed_zone(project, managed_zone, managed_zone_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV1::Operation

Update an existing ManagedZone.

Parameters:

  • project (String) —

    Identifies the project addressed by this request.

  • managed_zone (String) —

    Identifies the managed zone addressed by this request. Can be the managed zone name or id.

  • managed_zone_object (Google::Apis::DnsV1::ManagedZone) (defaults to: nil)
  • client_operation_id (String) —

    For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



648
649
650
651
652
653
654
655
656
657
658
659
660
661
 
# File 'generated/google/apis/dns_v1/service.rb', line 648

def update_managed_zone(project, managed_zone, managed_zone_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{project}/managedZones/{managedZone}', options)
  command.request_representation = Google::Apis::DnsV1::ManagedZone::Representation
  command.request_object = managed_zone_object
  command.response_representation = Google::Apis::DnsV1::Operation::Representation
  command.response_class = Google::Apis::DnsV1::Operation
  command.params['project'] = project unless project.nil?
  command.params['managedZone'] = managed_zone unless managed_zone.nil?
  command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end