GoogleApi.DNS.V1.Api.ManagedZones (google_api_dns v0.32.0)

View Source

API calls for all endpoints tagged ManagedZones.

Summary

Functions

dns_managed_zones_create(connection, project, optional_params \\ [], opts \\ [])

Creates a new ManagedZone.

dns_managed_zones_delete(connection, project, managed_zone, optional_params \\ [], opts \\ [])

Deletes a previously created ManagedZone.

dns_managed_zones_get(connection, project, managed_zone, optional_params \\ [], opts \\ [])

Fetches the representation of an existing ManagedZone.

dns_managed_zones_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

dns_managed_zones_list(connection, project, optional_params \\ [], opts \\ [])

Enumerates ManagedZones that have been created but not yet deleted.

dns_managed_zones_patch(connection, project, managed_zone, optional_params \\ [], opts \\ [])

Applies a partial update to an existing ManagedZone.

dns_managed_zones_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

dns_managed_zones_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this returns an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

dns_managed_zones_update(connection, project, managed_zone, optional_params \\ [], opts \\ [])

Updates an existing ManagedZone.

Functions

dns_managed_zones_create(connection, project, optional_params \\ [], opts \\ [])

@spec dns_managed_zones_create(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.DNS.V1.Model.ManagedZone.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new ManagedZone.

Parameters

  • connection (type: GoogleApi.DNS.V1.Connection.t) - Connection to server
  • project (type: String.t) - Identifies the project addressed by this request.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :clientOperationId (type: String.t) - For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
    • :body (type: GoogleApi.DNS.V1.Model.ManagedZone.t) -
  • opts (type: keyword()) - Call options

Returns

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

dns_managed_zones_delete(connection, project, managed_zone, optional_params \\ [], opts \\ [])

@spec dns_managed_zones_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Deletes a previously created ManagedZone.

Parameters

  • connection (type: GoogleApi.DNS.V1.Connection.t) - Connection to server
  • project (type: String.t) - Identifies the project addressed by this request.
  • managed_zone (type: String.t) - Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :clientOperationId (type: String.t) - For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
  • opts (type: keyword()) - Call options

Returns

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

dns_managed_zones_get(connection, project, managed_zone, optional_params \\ [], opts \\ [])

@spec dns_managed_zones_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DNS.V1.Model.ManagedZone.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Fetches the representation of an existing ManagedZone.

Parameters

  • connection (type: GoogleApi.DNS.V1.Connection.t) - Connection to server
  • project (type: String.t) - Identifies the project addressed by this request.
  • managed_zone (type: String.t) - Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :clientOperationId (type: String.t) - For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
  • opts (type: keyword()) - Call options

Returns

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

dns_managed_zones_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])

@spec dns_managed_zones_get_iam_policy(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DNS.V1.Model.GoogleIamV1Policy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters

  • connection (type: GoogleApi.DNS.V1.Connection.t) - Connection to server
  • resource (type: String.t) - REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DNS.V1.Model.GoogleIamV1GetIamPolicyRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

dns_managed_zones_list(connection, project, optional_params \\ [], opts \\ [])

@spec dns_managed_zones_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.DNS.V1.Model.ManagedZonesListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Enumerates ManagedZones that have been created but not yet deleted.

Parameters

  • connection (type: GoogleApi.DNS.V1.Connection.t) - Connection to server
  • project (type: String.t) - Identifies the project addressed by this request.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :dnsName (type: String.t) - Restricts the list to return only zones with this domain name.
    • :maxResults (type: integer()) - Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
    • :pageToken (type: String.t) - Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
  • opts (type: keyword()) - Call options

Returns

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

dns_managed_zones_patch(connection, project, managed_zone, optional_params \\ [], opts \\ [])

@spec dns_managed_zones_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DNS.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Applies a partial update to an existing ManagedZone.

Parameters

  • connection (type: GoogleApi.DNS.V1.Connection.t) - Connection to server
  • project (type: String.t) - Identifies the project addressed by this request.
  • managed_zone (type: String.t) - Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :clientOperationId (type: String.t) - For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
    • :body (type: GoogleApi.DNS.V1.Model.ManagedZone.t) -
  • opts (type: keyword()) - Call options

Returns

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

dns_managed_zones_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])

@spec dns_managed_zones_set_iam_policy(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DNS.V1.Model.GoogleIamV1Policy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters

  • connection (type: GoogleApi.DNS.V1.Connection.t) - Connection to server
  • resource (type: String.t) - REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DNS.V1.Model.GoogleIamV1SetIamPolicyRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

dns_managed_zones_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])

@spec dns_managed_zones_test_iam_permissions(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DNS.V1.Model.GoogleIamV1TestIamPermissionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns permissions that a caller has on the specified resource. If the resource does not exist, this returns an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters

  • connection (type: GoogleApi.DNS.V1.Connection.t) - Connection to server
  • resource (type: String.t) - REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DNS.V1.Model.GoogleIamV1TestIamPermissionsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

dns_managed_zones_update(connection, project, managed_zone, optional_params \\ [], opts \\ [])

@spec dns_managed_zones_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DNS.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an existing ManagedZone.

Parameters

  • connection (type: GoogleApi.DNS.V1.Connection.t) - Connection to server
  • project (type: String.t) - Identifies the project addressed by this request.
  • managed_zone (type: String.t) - Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :clientOperationId (type: String.t) - For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
    • :body (type: GoogleApi.DNS.V1.Model.ManagedZone.t) -
  • opts (type: keyword()) - Call options

Returns

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