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

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

Overview

Cloud DNS API

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

#initializeDnsService

Returns a new instance of DnsService.


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

def initialize
  super('https://dns.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

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_userString

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.


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

def quota_user
  @quota_user
end

Instance Method Details

#create_change(project, managed_zone, change_object = nil, client_operation_id: nil, fields: nil, quota_user: 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) (defaults to: nil)

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

  • 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:


77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'generated/google/apis/dns_v1/service.rb', line 77

def create_change(project, managed_zone, change_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'dns/v1/projects/{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?
  execute_or_queue_command(command, &block)
end

#create_managed_zone(project, managed_zone_object = nil, client_operation_id: nil, fields: nil, quota_user: 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) (defaults to: nil)

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

  • 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:


382
383
384
385
386
387
388
389
390
391
392
393
# File 'generated/google/apis/dns_v1/service.rb', line 382

def create_managed_zone(project, managed_zone_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'dns/v1/projects/{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?
  execute_or_queue_command(command, &block)
end

#create_policy(project, policy_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV1::Policy

Create a new Policy

Parameters:

  • project (String)

    Identifies the project addressed by this request.

  • policy_object (Google::Apis::DnsV1::Policy) (defaults to: nil)
  • client_operation_id (String) (defaults to: nil)

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

  • 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:


616
617
618
619
620
621
622
623
624
625
626
627
# File 'generated/google/apis/dns_v1/service.rb', line 616

def create_policy(project, policy_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'dns/v1/projects/{project}/policies', options)
  command.request_representation = Google::Apis::DnsV1::Policy::Representation
  command.request_object = policy_object
  command.response_representation = Google::Apis::DnsV1::Policy::Representation
  command.response_class = Google::Apis::DnsV1::Policy
  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?
  execute_or_queue_command(command, &block)
end

#delete_managed_zone(project, managed_zone, client_operation_id: nil, fields: nil, quota_user: 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) (defaults to: nil)

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

  • 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:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


421
422
423
424
425
426
427
428
429
# File 'generated/google/apis/dns_v1/service.rb', line 421

def delete_managed_zone(project, managed_zone, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'dns/v1/projects/{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?
  execute_or_queue_command(command, &block)
end

#delete_policy(project, policy, client_operation_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Delete a previously created Policy. Will fail if the policy is still being referenced by a network.

Parameters:

  • project (String)

    Identifies the project addressed by this request.

  • policy (String)

    User given friendly name of the policy addressed by this request.

  • client_operation_id (String) (defaults to: nil)

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

  • 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:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


655
656
657
658
659
660
661
662
663
# File 'generated/google/apis/dns_v1/service.rb', line 655

def delete_policy(project, policy, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'dns/v1/projects/{project}/policies/{policy}', options)
  command.params['project'] = project unless project.nil?
  command.params['policy'] = policy unless policy.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?
  execute_or_queue_command(command, &block)
end

#get_change(project, managed_zone, change_id, client_operation_id: nil, fields: nil, quota_user: 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) (defaults to: nil)

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

  • 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:


120
121
122
123
124
125
126
127
128
129
130
131
# File 'generated/google/apis/dns_v1/service.rb', line 120

def get_change(project, managed_zone, change_id, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'dns/v1/projects/{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?
  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, 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) (defaults to: nil)

    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) (defaults to: nil)

    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) (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:


213
214
215
216
217
218
219
220
221
222
223
224
225
# File 'generated/google/apis/dns_v1/service.rb', line 213

def get_dns_key(project, managed_zone, dns_key_id, client_operation_id: nil, digest_type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'dns/v1/projects/{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?
  execute_or_queue_command(command, &block)
end

#get_managed_zone(project, managed_zone, client_operation_id: nil, fields: nil, quota_user: 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) (defaults to: nil)

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

  • 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:


457
458
459
460
461
462
463
464
465
466
467
# File 'generated/google/apis/dns_v1/service.rb', line 457

def get_managed_zone(project, managed_zone, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'dns/v1/projects/{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?
  execute_or_queue_command(command, &block)
end

#get_managed_zone_operation(project, managed_zone, operation, client_operation_id: nil, fields: nil, quota_user: 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) (defaults to: nil)

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

  • 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:


301
302
303
304
305
306
307
308
309
310
311
312
# File 'generated/google/apis/dns_v1/service.rb', line 301

def get_managed_zone_operation(project, managed_zone, operation, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'dns/v1/projects/{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?
  execute_or_queue_command(command, &block)
end

#get_policy(project, policy, client_operation_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV1::Policy

Fetch the representation of an existing Policy.

Parameters:

  • project (String)

    Identifies the project addressed by this request.

  • policy (String)

    User given friendly name of the policy addressed by this request.

  • client_operation_id (String) (defaults to: nil)

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

  • 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:


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

def get_policy(project, policy, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'dns/v1/projects/{project}/policies/{policy}', options)
  command.response_representation = Google::Apis::DnsV1::Policy::Representation
  command.response_class = Google::Apis::DnsV1::Policy
  command.params['project'] = project unless project.nil?
  command.params['policy'] = policy unless policy.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?
  execute_or_queue_command(command, &block)
end

#get_project(project, client_operation_id: nil, fields: nil, quota_user: 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) (defaults to: nil)

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

  • 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:


843
844
845
846
847
848
849
850
851
852
# File 'generated/google/apis/dns_v1/service.rb', line 843

def get_project(project, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'dns/v1/projects/{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?
  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, 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) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • sort_by (String) (defaults to: nil)

    Sorting criterion. The only supported value is change sequence.

  • sort_order (String) (defaults to: nil)

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

  • 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:


166
167
168
169
170
171
172
173
174
175
176
177
178
179
# File 'generated/google/apis/dns_v1/service.rb', line 166

def list_changes(project, managed_zone, max_results: nil, page_token: nil, sort_by: nil, sort_order: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'dns/v1/projects/{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?
  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, 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) (defaults to: nil)

    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) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • 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:


260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'generated/google/apis/dns_v1/service.rb', line 260

def list_dns_keys(project, managed_zone, digest_type: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'dns/v1/projects/{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?
  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, 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) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • sort_by (String) (defaults to: nil)

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

  • 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:


344
345
346
347
348
349
350
351
352
353
354
355
356
# File 'generated/google/apis/dns_v1/service.rb', line 344

def list_managed_zone_operations(project, managed_zone, max_results: nil, page_token: nil, sort_by: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'dns/v1/projects/{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?
  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, 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) (defaults to: nil)

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

  • max_results (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • 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:


497
498
499
500
501
502
503
504
505
506
507
508
# File 'generated/google/apis/dns_v1/service.rb', line 497

def list_managed_zones(project, dns_name: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'dns/v1/projects/{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?
  execute_or_queue_command(command, &block)
end

#list_policies(project, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV1::PoliciesListResponse

Enumerate all Policies associated with a project.

Parameters:

  • project (String)

    Identifies the project addressed by this request.

  • max_results (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • 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:


728
729
730
731
732
733
734
735
736
737
738
# File 'generated/google/apis/dns_v1/service.rb', line 728

def list_policies(project, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'dns/v1/projects/{project}/policies', options)
  command.response_representation = Google::Apis::DnsV1::PoliciesListResponse::Representation
  command.response_class = Google::Apis::DnsV1::PoliciesListResponse
  command.params['project'] = project unless project.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?
  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, 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) (defaults to: nil)

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

  • name (String) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • type (String) (defaults to: nil)

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

  • 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:


889
890
891
892
893
894
895
896
897
898
899
900
901
902
# File 'generated/google/apis/dns_v1/service.rb', line 889

def list_resource_record_sets(project, managed_zone, max_results: nil, name: nil, page_token: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'dns/v1/projects/{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?
  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, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV1::Operation

Apply a partial update to 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) (defaults to: nil)

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

  • 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:


537
538
539
540
541
542
543
544
545
546
547
548
549
# File 'generated/google/apis/dns_v1/service.rb', line 537

def patch_managed_zone(project, managed_zone, managed_zone_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'dns/v1/projects/{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?
  execute_or_queue_command(command, &block)
end

#patch_policy(project, policy, policy_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV1::PoliciesPatchResponse

Apply a partial update to an existing Policy.

Parameters:

  • project (String)

    Identifies the project addressed by this request.

  • policy (String)

    User given friendly name of the policy addressed by this request.

  • policy_object (Google::Apis::DnsV1::Policy) (defaults to: nil)
  • client_operation_id (String) (defaults to: nil)

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

  • 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:


766
767
768
769
770
771
772
773
774
775
776
777
778
# File 'generated/google/apis/dns_v1/service.rb', line 766

def patch_policy(project, policy, policy_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'dns/v1/projects/{project}/policies/{policy}', options)
  command.request_representation = Google::Apis::DnsV1::Policy::Representation
  command.request_object = policy_object
  command.response_representation = Google::Apis::DnsV1::PoliciesPatchResponse::Representation
  command.response_class = Google::Apis::DnsV1::PoliciesPatchResponse
  command.params['project'] = project unless project.nil?
  command.params['policy'] = policy unless policy.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?
  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, 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) (defaults to: nil)

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

  • 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:


578
579
580
581
582
583
584
585
586
587
588
589
590
# File 'generated/google/apis/dns_v1/service.rb', line 578

def update_managed_zone(project, managed_zone, managed_zone_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'dns/v1/projects/{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?
  execute_or_queue_command(command, &block)
end

#update_policy(project, policy, policy_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV1::PoliciesUpdateResponse

Update an existing Policy.

Parameters:

  • project (String)

    Identifies the project addressed by this request.

  • policy (String)

    User given friendly name of the policy addressed by this request.

  • policy_object (Google::Apis::DnsV1::Policy) (defaults to: nil)
  • client_operation_id (String) (defaults to: nil)

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

  • 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:


806
807
808
809
810
811
812
813
814
815
816
817
818
# File 'generated/google/apis/dns_v1/service.rb', line 806

def update_policy(project, policy, policy_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'dns/v1/projects/{project}/policies/{policy}', options)
  command.request_representation = Google::Apis::DnsV1::Policy::Representation
  command.request_object = policy_object
  command.response_representation = Google::Apis::DnsV1::PoliciesUpdateResponse::Representation
  command.response_class = Google::Apis::DnsV1::PoliciesUpdateResponse
  command.params['project'] = project unless project.nil?
  command.params['policy'] = policy unless policy.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?
  execute_or_queue_command(command, &block)
end