google_api_dns v0.0.1 GoogleApi.DNS.V1.Api.ManagedZones View Source

API calls for all endpoints tagged ManagedZones.

Link to this section Summary

Functions

Fetch the representation of an existing ManagedZone

Enumerate ManagedZones that have been created but not yet deleted

Link to this section Functions

Link to this function dns_managed_zones_create(connection, project, opts \\ []) View Source
dns_managed_zones_create(Tesla.Env.client, String.t, keyword) ::
  {:ok, GoogleApi.DNS.V1.Model.ManagedZone.t} |
  {:error, Tesla.Env.t}

Create a new ManagedZone.

Parameters

  • connection (GoogleApi.DNS.V1.Connection): Connection to server
  • project (String): Identifies the project addressed by this request.
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (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.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :body (ManagedZone):

Returns

{:ok, %GoogleApi.DNS.V1.Model.ManagedZone{}} on success {:error, info} on failure

Link to this function dns_managed_zones_delete(connection, project, managed_zone, opts \\ []) View Source
dns_managed_zones_delete(Tesla.Env.client, String.t, String.t, keyword) ::
  {:ok, nil} |
  {:error, Tesla.Env.t}

Delete a previously created ManagedZone.

Parameters

  • connection (GoogleApi.DNS.V1.Connection): Connection to server
  • 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.
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (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.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function dns_managed_zones_get(connection, project, managed_zone, opts \\ []) View Source
dns_managed_zones_get(Tesla.Env.client, String.t, String.t, keyword) ::
  {:ok, GoogleApi.DNS.V1.Model.ManagedZone.t} |
  {:error, Tesla.Env.t}

Fetch the representation of an existing ManagedZone.

Parameters

  • connection (GoogleApi.DNS.V1.Connection): Connection to server
  • 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.
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (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.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns

{:ok, %GoogleApi.DNS.V1.Model.ManagedZone{}} on success {:error, info} on failure

Link to this function dns_managed_zones_list(connection, project, opts \\ []) View Source
dns_managed_zones_list(Tesla.Env.client, String.t, keyword) ::
  {:ok, GoogleApi.DNS.V1.Model.ManagedZonesListResponse.t} |
  {:error, Tesla.Env.t}

Enumerate ManagedZones that have been created but not yet deleted.

Parameters

  • connection (GoogleApi.DNS.V1.Connection): Connection to server
  • project (String): Identifies the project addressed by this request.
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (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.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :dns_name (String): Restricts the list to return only zones with this domain name.
    • :max_results (Integer): Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
    • :page_token (String): Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.

Returns

{:ok, %GoogleApi.DNS.V1.Model.ManagedZonesListResponse{}} on success {:error, info} on failure