google_api_dns v0.14.0 GoogleApi.DNS.V1.Api.DnsKeys View Source

API calls for all endpoints tagged DnsKeys.

Link to this section Summary

Link to this section Functions

Link to this function

dns_dns_keys_get(connection, project, managed_zone, dns_key_id, optional_params \\ [], opts \\ [])

View Source
dns_dns_keys_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DNS.V1.Model.DnsKey.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Fetch the representation of an existing DnsKey.

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.
  • dns_key_id (type: String.t) - The identifier of the requested DnsKey.
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :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.
    • :digestType (type: String.t) - An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DNS.V1.Model.DnsKey{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
dns_dns_keys_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DNS.V1.Model.DnsKeysListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Enumerate DnsKeys to a ResourceRecordSet collection.

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

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :digestType (type: String.t) - An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed.
    • :maxResults (type: integer()) - Optional. Maximum number of results to be returned. If unspecified, the server will decide 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.DnsKeysListResponse{}} on success
  • {:error, info} on failure