class Google::Apis::DnsV1::DnsService
Cloud DNS API
@example
require 'google/apis/dns_v1' Dns = Google::Apis::DnsV1 # Alias the module service = Dns::DnsService.new
Attributes
@return [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.
@return [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.
Public Class Methods
# File lib/google/apis/dns_v1/service.rb, line 45 def initialize super('https://dns.googleapis.com/', '', client_name: 'google-apis-dns_v1', client_version: Google::Apis::DnsV1::GEM_VERSION) @batch_path = 'batch' end
Public Instance Methods
Atomically updates the ResourceRecordSet
collection. @param [String] project
Identifies the project addressed by this request.
@param [String] managed_zone
Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
@param [Google::Apis::DnsV1::Change] change_object @param [String] client_operation_id
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DnsV1::Change] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::DnsV1::Change]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/dns_v1/service.rb, line 79 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
Creates a new ManagedZone
. @param [String] project
Identifies the project addressed by this request.
@param [Google::Apis::DnsV1::ManagedZone] managed_zone_object @param [String] client_operation_id
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DnsV1::ManagedZone] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::DnsV1::ManagedZone]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/dns_v1/service.rb, line 384 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
Creates a new Policy
. @param [String] project
Identifies the project addressed by this request.
@param [Google::Apis::DnsV1::Policy] policy_object @param [String] client_operation_id
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DnsV1::Policy] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::DnsV1::Policy]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/dns_v1/service.rb, line 618 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
Creates a new ResourceRecordSet
. @param [String] project
Identifies the project addressed by this request.
@param [String] managed_zone
Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
@param [Google::Apis::DnsV1::ResourceRecordSet] resource_record_set_object @param [String] client_operation_id
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DnsV1::ResourceRecordSet] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::DnsV1::ResourceRecordSet]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/dns_v1/service.rb, line 883 def create_resource_record_set(project, managed_zone, resource_record_set_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}/rrsets', options) command.request_representation = Google::Apis::DnsV1::ResourceRecordSet::Representation command.request_object = resource_record_set_object command.response_representation = Google::Apis::DnsV1::ResourceRecordSet::Representation command.response_class = Google::Apis::DnsV1::ResourceRecordSet 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
Deletes a previously created ManagedZone
. @param [String] project
Identifies the project addressed by this request.
@param [String] managed_zone
Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
@param [String] client_operation_id
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed
@return [void]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/dns_v1/service.rb, line 423 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
Deletes a previously created Policy
. Fails if the policy is still being referenced by a network. @param [String] project
Identifies the project addressed by this request.
@param [String] policy
User given friendly name of the policy addressed by this request.
@param [String] client_operation_id
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed
@return [void]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/dns_v1/service.rb, line 657 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
Deletes a previously created ResourceRecordSet
. @param [String] project
Identifies the project addressed by this request.
@param [String] managed_zone
Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
@param [String] name
Fully qualified domain name.
@param [String] type
RRSet type.
@param [String] client_operation_id
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DnsV1::ResourceRecordSetsDeleteResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::DnsV1::ResourceRecordSetsDeleteResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/dns_v1/service.rb, line 927 def delete_resource_record_set(project, managed_zone, name, type, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'dns/v1/projects/{project}/managedZones/{managedZone}/rrsets/{name}/{type}', options) command.response_representation = Google::Apis::DnsV1::ResourceRecordSetsDeleteResponse::Representation command.response_class = Google::Apis::DnsV1::ResourceRecordSetsDeleteResponse command.params['project'] = project unless project.nil? command.params['managedZone'] = managed_zone unless managed_zone.nil? command.params['name'] = name unless name.nil? command.params['type'] = type unless type.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
Fetches the representation of an existing Change
. @param [String] project
Identifies the project addressed by this request.
@param [String] managed_zone
Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
@param [String] change_id
The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse.
@param [String] client_operation_id
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DnsV1::Change] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::DnsV1::Change]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/dns_v1/service.rb, line 122 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
Fetches the representation of an existing DnsKey
. @param [String] project
Identifies the project addressed by this request.
@param [String] managed_zone
Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
@param [String] dns_key_id
The identifier of the requested DnsKey.
@param [String] client_operation_id
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
@param [String] digest_type
An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type is computed and displayed.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DnsV1::DnsKey] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::DnsV1::DnsKey]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/dns_v1/service.rb, line 215 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
Fetches the representation of an existing ManagedZone
. @param [String] project
Identifies the project addressed by this request.
@param [String] managed_zone
Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
@param [String] client_operation_id
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DnsV1::ManagedZone] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::DnsV1::ManagedZone]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/dns_v1/service.rb, line 459 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
Fetches the representation of an existing Operation
. @param [String] project
Identifies the project addressed by this request.
@param [String] managed_zone
Identifies the managed zone addressed by this request.
@param [String] operation
Identifies the operation addressed by this request (ID of the operation).
@param [String] client_operation_id
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DnsV1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::DnsV1::Operation]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/dns_v1/service.rb, line 303 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
Fetches the representation of an existing Policy
. @param [String] project
Identifies the project addressed by this request.
@param [String] policy
User given friendly name of the policy addressed by this request.
@param [String] client_operation_id
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DnsV1::Policy] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::DnsV1::Policy]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/dns_v1/service.rb, line 692 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
Fetches the representation of an existing Project
. @param [String] project
Identifies the project addressed by this request.
@param [String] client_operation_id
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DnsV1::Project] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::DnsV1::Project]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/dns_v1/service.rb, line 845 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
Fetches the representation of an existing ResourceRecordSet
. @param [String] project
Identifies the project addressed by this request.
@param [String] managed_zone
Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
@param [String] name
Fully qualified domain name.
@param [String] type
RRSet type.
@param [String] client_operation_id
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DnsV1::ResourceRecordSet] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::DnsV1::ResourceRecordSet]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/dns_v1/service.rb, line 971 def get_resource_record_set(project, managed_zone, name, type, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'dns/v1/projects/{project}/managedZones/{managedZone}/rrsets/{name}/{type}', options) command.response_representation = Google::Apis::DnsV1::ResourceRecordSet::Representation command.response_class = Google::Apis::DnsV1::ResourceRecordSet command.params['project'] = project unless project.nil? command.params['managedZone'] = managed_zone unless managed_zone.nil? command.params['name'] = name unless name.nil? command.params['type'] = type unless type.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
Enumerates Changes to a ResourceRecordSet
collection. @param [String] project
Identifies the project addressed by this request.
@param [String] managed_zone
Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
@param [Fixnum] max_results
Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
@param [String] page_token
Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
@param [String] sort_by
Sorting criterion. The only supported value is change sequence.
@param [String] sort_order
Sorting order direction: 'ascending' or 'descending'.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DnsV1::ListChangesResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::DnsV1::ListChangesResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/dns_v1/service.rb, line 168 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
Enumerates DnsKeys to a ResourceRecordSet
collection. @param [String] project
Identifies the project addressed by this request.
@param [String] managed_zone
Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
@param [String] digest_type
An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type is computed and displayed.
@param [Fixnum] max_results
Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
@param [String] page_token
Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DnsV1::DnsKeysListResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::DnsV1::DnsKeysListResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/dns_v1/service.rb, line 262 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
Enumerates Operations for the given ManagedZone
. @param [String] project
Identifies the project addressed by this request.
@param [String] managed_zone
Identifies the managed zone addressed by this request.
@param [Fixnum] max_results
Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
@param [String] page_token
Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
@param [String] sort_by
Sorting criterion. The only supported values are START_TIME and ID.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DnsV1::ManagedZoneOperationsListResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::DnsV1::ManagedZoneOperationsListResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/dns_v1/service.rb, line 346 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
Enumerates ManagedZones that have been created but not yet deleted. @param [String] project
Identifies the project addressed by this request.
@param [String] dns_name
Restricts the list to return only zones with this domain name.
@param [Fixnum] max_results
Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
@param [String] page_token
Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DnsV1::ListManagedZonesResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::DnsV1::ListManagedZonesResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/dns_v1/service.rb, line 499 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
Enumerates all Policies associated with a project. @param [String] project
Identifies the project addressed by this request.
@param [Fixnum] max_results
Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
@param [String] page_token
Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DnsV1::PoliciesListResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::DnsV1::PoliciesListResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/dns_v1/service.rb, line 730 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
Enumerates ResourceRecordSets that you have created but not yet deleted. @param [String] project
Identifies the project addressed by this request.
@param [String] managed_zone
Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
@param [Fixnum] max_results
Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
@param [String] name
Restricts the list to return only records with this fully qualified domain name.
@param [String] page_token
Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
@param [String] type
Restricts the list to return only records of this type. If present, the "name" parameter must also be present.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DnsV1::ListResourceRecordSetsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::DnsV1::ListResourceRecordSetsResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/dns_v1/service.rb, line 1020 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
Applies a partial update to an existing ManagedZone
. @param [String] project
Identifies the project addressed by this request.
@param [String] managed_zone
Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
@param [Google::Apis::DnsV1::ManagedZone] managed_zone_object @param [String] client_operation_id
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DnsV1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::DnsV1::Operation]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/dns_v1/service.rb, line 539 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
Applies a partial update to an existing Policy
. @param [String] project
Identifies the project addressed by this request.
@param [String] policy
User given friendly name of the policy addressed by this request.
@param [Google::Apis::DnsV1::Policy] policy_object @param [String] client_operation_id
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DnsV1::PoliciesPatchResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::DnsV1::PoliciesPatchResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/dns_v1/service.rb, line 768 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
Applies a partial update to an existing ResourceRecordSet
. @param [String] project
Identifies the project addressed by this request.
@param [String] managed_zone
Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
@param [String] name
Fully qualified domain name.
@param [String] type
RRSet type.
@param [Google::Apis::DnsV1::ResourceRecordSet] resource_record_set_object @param [String] client_operation_id
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DnsV1::ResourceRecordSet] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::DnsV1::ResourceRecordSet]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/dns_v1/service.rb, line 1066 def patch_resource_record_set(project, managed_zone, name, type, resource_record_set_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}/rrsets/{name}/{type}', options) command.request_representation = Google::Apis::DnsV1::ResourceRecordSet::Representation command.request_object = resource_record_set_object command.response_representation = Google::Apis::DnsV1::ResourceRecordSet::Representation command.response_class = Google::Apis::DnsV1::ResourceRecordSet command.params['project'] = project unless project.nil? command.params['managedZone'] = managed_zone unless managed_zone.nil? command.params['name'] = name unless name.nil? command.params['type'] = type unless type.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
Updates an existing ManagedZone
. @param [String] project
Identifies the project addressed by this request.
@param [String] managed_zone
Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
@param [Google::Apis::DnsV1::ManagedZone] managed_zone_object @param [String] client_operation_id
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DnsV1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::DnsV1::Operation]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/dns_v1/service.rb, line 580 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
Updates an existing Policy
. @param [String] project
Identifies the project addressed by this request.
@param [String] policy
User given friendly name of the policy addressed by this request.
@param [Google::Apis::DnsV1::Policy] policy_object @param [String] client_operation_id
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DnsV1::PoliciesUpdateResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::DnsV1::PoliciesUpdateResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/dns_v1/service.rb, line 808 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
Protected Instance Methods
# File lib/google/apis/dns_v1/service.rb, line 1084 def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? end