Class: Google::Apis::DnsV1beta2::DnsService

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

Overview

Google Cloud DNS API

Configures and serves authoritative DNS records.

Examples:

require 'google/apis/dns_v1beta2'

Dns = Google::Apis::DnsV1beta2 # 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.



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

def initialize
  super('https://dns.googleapis.com/', 'dns/v1beta2/projects/')
  @batch_path = 'batch/dns/v1beta2'
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_v1beta2/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Returns:

  • (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.



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

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String) —

    Deprecated. Please use quotaUser instead.



47
48
49
 
# File 'generated/google/apis/dns_v1beta2/service.rb', line 47

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::DnsV1beta2::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::DnsV1beta2::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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'generated/google/apis/dns_v1beta2/service.rb', line 83

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::DnsV1beta2::Change::Representation
  command.request_object = change_object
  command.response_representation = Google::Apis::DnsV1beta2::Change::Representation
  command.response_class = Google::Apis::DnsV1beta2::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::DnsV1beta2::ManagedZone

Create a new ManagedZone.

Parameters:

  • project (String) —

    Identifies the project addressed by this request.

  • managed_zone_object (Google::Apis::DnsV1beta2::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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'generated/google/apis/dns_v1beta2/service.rb', line 409

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::DnsV1beta2::ManagedZone::Representation
  command.request_object = managed_zone_object
  command.response_representation = Google::Apis::DnsV1beta2::ManagedZone::Representation
  command.response_class = Google::Apis::DnsV1beta2::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

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

Create a new Policy

Parameters:

  • project (String) —

    Identifies the project addressed by this request.

  • policy_object (Google::Apis::DnsV1beta2::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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



661
662
663
664
665
666
667
668
669
670
671
672
673
 
# File 'generated/google/apis/dns_v1beta2/service.rb', line 661

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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



451
452
453
454
455
456
457
458
459
460
 
# File 'generated/google/apis/dns_v1beta2/service.rb', line 451

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

#delete_policy(project, policy, 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 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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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



703
704
705
706
707
708
709
710
711
712
 
# File 'generated/google/apis/dns_v1beta2/service.rb', line 703

def delete_policy(project, policy, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, '{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?
  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::DnsV1beta2::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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'generated/google/apis/dns_v1beta2/service.rb', line 129

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::DnsV1beta2::Change::Representation
  command.response_class = Google::Apis::DnsV1beta2::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::DnsV1beta2::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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'generated/google/apis/dns_v1beta2/service.rb', line 228

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::DnsV1beta2::DnsKey::Representation
  command.response_class = Google::Apis::DnsV1beta2::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::DnsV1beta2::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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'generated/google/apis/dns_v1beta2/service.rb', line 490

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::DnsV1beta2::ManagedZone::Representation
  command.response_class = Google::Apis::DnsV1beta2::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::DnsV1beta2::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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'generated/google/apis/dns_v1beta2/service.rb', line 322

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::DnsV1beta2::Operation::Representation
  command.response_class = Google::Apis::DnsV1beta2::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_policy(project, policy, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV1beta2::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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    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
 
# File 'generated/google/apis/dns_v1beta2/service.rb', line 741

def get_policy(project, policy, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{project}/policies/{policy}', options)
  command.response_representation = Google::Apis::DnsV1beta2::Policy::Representation
  command.response_class = Google::Apis::DnsV1beta2::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?
  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::DnsV1beta2::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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



906
907
908
909
910
911
912
913
914
915
916
 
# File 'generated/google/apis/dns_v1beta2/service.rb', line 906

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::DnsV1beta2::Project::Representation
  command.response_class = Google::Apis::DnsV1beta2::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::DnsV1beta2::ChangesListResponse

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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'generated/google/apis/dns_v1beta2/service.rb', line 178

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::DnsV1beta2::ChangesListResponse::Representation
  command.response_class = Google::Apis::DnsV1beta2::ChangesListResponse
  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::DnsV1beta2::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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'generated/google/apis/dns_v1beta2/service.rb', line 278

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::DnsV1beta2::DnsKeysListResponse::Representation
  command.response_class = Google::Apis::DnsV1beta2::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::DnsV1beta2::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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'generated/google/apis/dns_v1beta2/service.rb', line 368

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::DnsV1beta2::ManagedZoneOperationsListResponse::Representation
  command.response_class = Google::Apis::DnsV1beta2::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::DnsV1beta2::ManagedZonesListResponse

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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



533
534
535
536
537
538
539
540
541
542
543
544
545
 
# File 'generated/google/apis/dns_v1beta2/service.rb', line 533

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::DnsV1beta2::ManagedZonesListResponse::Representation
  command.response_class = Google::Apis::DnsV1beta2::ManagedZonesListResponse
  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_policies(project, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV1beta2::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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'generated/google/apis/dns_v1beta2/service.rb', line 782

def list_policies(project, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{project}/policies', options)
  command.response_representation = Google::Apis::DnsV1beta2::PoliciesListResponse::Representation
  command.response_class = Google::Apis::DnsV1beta2::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?
  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::DnsV1beta2::ResourceRecordSetsListResponse

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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'generated/google/apis/dns_v1beta2/service.rb', line 955

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::DnsV1beta2::ResourceRecordSetsListResponse::Representation
  command.response_class = Google::Apis::DnsV1beta2::ResourceRecordSetsListResponse
  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::DnsV1beta2::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::DnsV1beta2::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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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::DnsV1beta2::ManagedZone::Representation
  command.request_object = managed_zone_object
  command.response_representation = Google::Apis::DnsV1beta2::Operation::Representation
  command.response_class = Google::Apis::DnsV1beta2::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

#patch_policy(project, policy, policy_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV1beta2::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::DnsV1beta2::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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'generated/google/apis/dns_v1beta2/service.rb', line 823

def patch_policy(project, policy, policy_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:patch, '{project}/policies/{policy}', options)
  command.request_representation = Google::Apis::DnsV1beta2::Policy::Representation
  command.request_object = policy_object
  command.response_representation = Google::Apis::DnsV1beta2::PoliciesPatchResponse::Representation
  command.response_class = Google::Apis::DnsV1beta2::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?
  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::DnsV1beta2::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::DnsV1beta2::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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'generated/google/apis/dns_v1beta2/service.rb', line 620

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::DnsV1beta2::ManagedZone::Representation
  command.request_object = managed_zone_object
  command.response_representation = Google::Apis::DnsV1beta2::Operation::Representation
  command.response_class = Google::Apis::DnsV1beta2::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_policy(project, policy, policy_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV1beta2::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::DnsV1beta2::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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



866
867
868
869
870
871
872
873
874
875
876
877
878
879
 
# File 'generated/google/apis/dns_v1beta2/service.rb', line 866

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