google_api_dns v0.22.1

GoogleApi.DNS.V1.Api.ManagedZoneOperations (google_api_dns v0.22.1) View Source

API calls for all endpoints tagged ManagedZoneOperations.

Link to this section Summary

Functions

dns_managed_zone_operations_get(connection, project, managed_zone, operation, optional_params \\ [], opts \\ [])

Fetches the representation of an existing Operation.

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

Enumerates Operations for the given ManagedZone.

Link to this section Functions

Link to this function

dns_managed_zone_operations_get(connection, project, managed_zone, operation, optional_params \\ [], opts \\ [])

View Source

Specs

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

Fetches the representation of an existing Operation.

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.
  • operation (type: String.t) - Identifies the operation addressed by this request (ID of the operation).
  • 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.Operation{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Specs

dns_managed_zone_operations_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DNS.V1.Model.ManagedZoneOperationsListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Enumerates Operations for the given 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.
  • 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").
    • :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.
    • :sortBy (type: String.t) - Sorting criterion. The only supported values are START_TIME and ID.
  • opts (type: keyword()) - Call options

Returns

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