Cloud DNS API - Module Google::Cloud (v1.1.1)

Reference documentation and code samples for the Cloud DNS API module Google::Cloud.

Methods

.dns

def self.dns(project_id = nil, credentials = nil, scope: nil, retries: nil, timeout: nil) -> Google::Cloud::Dns::Project

Creates a new Project instance connected to the DNS service. Each call creates a new connection.

For more information on connecting to Google Cloud see the Authentication Guide.

Parameters
  • project_id (String) — Identifier for a DNS project. If not present, the default project for the credentials is used.
  • credentials (Google::Auth::Credentials) — A Google::Auth::Credentials object. (See Dns::Credentials) @note Warning: Passing a String to a keyfile path or a Hash of credentials is deprecated. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data.

    @example

    # The recommended way to provide credentials is to use the make_creds method # on the appropriate credentials class for your environment.

    credentials = ::Google::Auth::ServiceAccountCredentials.make_creds( json_key_io: ::File.open("/path/to/keyfile.json") )

    dns = Google::Cloud::Dns.new( project_id: "my-project-id", credentials: credentials )

  • scope (String, Array<String>) (defaults to: nil) —

    The OAuth 2.0 scopes controlling the set of resources and operations that the connection can access. See Using OAuth 2.0 to Access Google APIs.

    The default scope is:

    • https://www.googleapis.com/auth/ndev.clouddns.readwrite
  • retries (Integer) (defaults to: nil) — Number of times to retry requests on server error. The default value is 3. Optional.
  • timeout (Integer) (defaults to: nil) — Default timeout to use in requests. Optional.
Returns
Example 
require "google/cloud"

dns = Google::Cloud.dns "my-project", "/path/to/keyfile.json"

zone = dns.zone "example-com"

#dns

def dns(scope: nil, retries: nil, timeout: nil) -> Google::Cloud::Dns::Project

Creates a new object for connecting to the DNS service. Each call creates a new connection.

For more information on connecting to Google Cloud see the Authentication Guide.

Parameters
  • scope (String, Array<String>) (defaults to: nil) —

    The OAuth 2.0 scopes controlling the set of resources and operations that the connection can access. See Using OAuth 2.0 to Access Google APIs.

    The default scope is:

    • https://www.googleapis.com/auth/ndev.clouddns.readwrite
  • retries (Integer) (defaults to: nil) — Number of times to retry requests on server error. The default value is 3. Optional.
  • timeout (Integer) (defaults to: nil) — Default timeout to use in requests. Optional.
Returns
Examples 
require "google/cloud"

gcloud = Google::Cloud.new
dns = gcloud.dns
zone = dns.zone "example-com"
zone.records.each do |record|
  puts record.name
end

The default scope can be overridden with the scope option:

require "google/cloud"

gcloud  = Google::Cloud.new
dns_readonly = "https://www.googleapis.com/auth/ndev.clouddns.readonly"
dns = gcloud.dns scope: dns_readonly