Class: Google::Apis::DnsV2beta1::DnsService
Overview
Google Cloud DNS API
Configures and serves authoritative DNS records.
Instance Attribute Summary collapse
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary
collapse
-
#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::DnsV2beta1::Change
-
#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::DnsV2beta1::ManagedZone
-
#delete_managed_zone(project, managed_zone, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
-
#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::DnsV2beta1::Change
-
#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::DnsV2beta1::DnsKey
-
#get_managed_zone(project, managed_zone, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV2beta1::ManagedZone
-
#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::DnsV2beta1::Operation
-
#get_project(project, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV2beta1::Project
-
#initialize ⇒ DnsService
constructor
A new instance of DnsService.
-
#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::DnsV2beta1::ChangesListResponse
-
#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::DnsV2beta1::DnsKeysListResponse
-
#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::DnsV2beta1::ManagedZoneOperationsListResponse
-
#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::DnsV2beta1::ManagedZonesListResponse
-
#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::DnsV2beta1::ResourceRecordSetsListResponse
-
#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::DnsV2beta1::Operation
-
#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::DnsV2beta1::Operation
#batch, #batch_upload, #fetch_all, #http
#logger
Constructor Details
Returns a new instance of DnsService
49
50
51
52
|
# File 'generated/google/apis/dns_v2beta1/service.rb', line 49
def initialize
super('https://www.googleapis.com/', 'dns/v2beta1/projects/')
@batch_path = 'batch/dns/v2beta1'
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.
38
39
40
|
# File 'generated/google/apis/dns_v2beta1/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.
43
44
45
|
# File 'generated/google/apis/dns_v2beta1/service.rb', line 43
def quota_user
@quota_user
end
|
#user_ip ⇒ String
Returns Deprecated. Please use quotaUser instead.
47
48
49
|
# File 'generated/google/apis/dns_v2beta1/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::DnsV2beta1::Change
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
# File 'generated/google/apis/dns_v2beta1/service.rb', line 78
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::DnsV2beta1::Change::Representation
command.request_object = change_object
command.response_representation = Google::Apis::DnsV2beta1::Change::Representation
command.response_class = Google::Apis::DnsV2beta1::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::DnsV2beta1::ManagedZone
354
355
356
357
358
359
360
361
362
363
364
365
366
|
# File 'generated/google/apis/dns_v2beta1/service.rb', line 354
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::DnsV2beta1::ManagedZone::Representation
command.request_object = managed_zone_object
command.response_representation = Google::Apis::DnsV2beta1::ManagedZone::Representation
command.response_class = Google::Apis::DnsV2beta1::ManagedZone
command.params['project'] = project unless project.nil?
command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
|
#delete_managed_zone(project, managed_zone, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
This method returns an undefined value.
391
392
393
394
395
396
397
398
399
400
|
# File 'generated/google/apis/dns_v2beta1/service.rb', line 391
def delete_managed_zone(project, managed_zone, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:delete, '{project}/managedZones/{managedZone}', options)
command.params['project'] = project unless project.nil?
command.params['managedZone'] = managed_zone unless managed_zone.nil?
command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
|
#get_change(project, managed_zone, change_id, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV2beta1::Change
117
118
119
120
121
122
123
124
125
126
127
128
129
|
# File 'generated/google/apis/dns_v2beta1/service.rb', line 117
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::DnsV2beta1::Change::Representation
command.response_class = Google::Apis::DnsV2beta1::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::DnsV2beta1::DnsKey
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
# File 'generated/google/apis/dns_v2beta1/service.rb', line 198
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::DnsV2beta1::DnsKey::Representation
command.response_class = Google::Apis::DnsV2beta1::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::DnsV2beta1::ManagedZone
425
426
427
428
429
430
431
432
433
434
435
436
|
# File 'generated/google/apis/dns_v2beta1/service.rb', line 425
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::DnsV2beta1::ManagedZone::Representation
command.response_class = Google::Apis::DnsV2beta1::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::DnsV2beta1::Operation
277
278
279
280
281
282
283
284
285
286
287
288
289
|
# File 'generated/google/apis/dns_v2beta1/service.rb', line 277
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::DnsV2beta1::Operation::Representation
command.response_class = Google::Apis::DnsV2beta1::Operation
command.params['project'] = project unless project.nil?
command.params['managedZone'] = managed_zone unless managed_zone.nil?
command.params['operation'] = operation unless operation.nil?
command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
|
#get_project(project, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV2beta1::Project
576
577
578
579
580
581
582
583
584
585
586
|
# File 'generated/google/apis/dns_v2beta1/service.rb', line 576
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::DnsV2beta1::Project::Representation
command.response_class = Google::Apis::DnsV2beta1::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::DnsV2beta1::ChangesListResponse
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
# File 'generated/google/apis/dns_v2beta1/service.rb', line 157
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::DnsV2beta1::ChangesListResponse::Representation
command.response_class = Google::Apis::DnsV2beta1::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::DnsV2beta1::DnsKeysListResponse
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
# File 'generated/google/apis/dns_v2beta1/service.rb', line 238
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::DnsV2beta1::DnsKeysListResponse::Representation
command.response_class = Google::Apis::DnsV2beta1::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::DnsV2beta1::ManagedZoneOperationsListResponse
316
317
318
319
320
321
322
323
324
325
326
327
328
329
|
# File 'generated/google/apis/dns_v2beta1/service.rb', line 316
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::DnsV2beta1::ManagedZoneOperationsListResponse::Representation
command.response_class = Google::Apis::DnsV2beta1::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::DnsV2beta1::ManagedZonesListResponse
462
463
464
465
466
467
468
469
470
471
472
473
474
|
# File 'generated/google/apis/dns_v2beta1/service.rb', line 462
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::DnsV2beta1::ManagedZonesListResponse::Representation
command.response_class = Google::Apis::DnsV2beta1::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_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::DnsV2beta1::ResourceRecordSetsListResponse
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
|
# File 'generated/google/apis/dns_v2beta1/service.rb', line 614
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::DnsV2beta1::ResourceRecordSetsListResponse::Representation
command.response_class = Google::Apis::DnsV2beta1::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::DnsV2beta1::Operation
500
501
502
503
504
505
506
507
508
509
510
511
512
513
|
# File 'generated/google/apis/dns_v2beta1/service.rb', line 500
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::DnsV2beta1::ManagedZone::Representation
command.request_object = managed_zone_object
command.response_representation = Google::Apis::DnsV2beta1::Operation::Representation
command.response_class = Google::Apis::DnsV2beta1::Operation
command.params['project'] = project unless project.nil?
command.params['managedZone'] = managed_zone unless managed_zone.nil?
command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
|
#update_managed_zone(project, managed_zone, managed_zone_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DnsV2beta1::Operation
539
540
541
542
543
544
545
546
547
548
549
550
551
552
|
# File 'generated/google/apis/dns_v2beta1/service.rb', line 539
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::DnsV2beta1::ManagedZone::Representation
command.request_object = managed_zone_object
command.response_representation = Google::Apis::DnsV2beta1::Operation::Representation
command.response_class = Google::Apis::DnsV2beta1::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
|