View Source GoogleApi.DNS.V1.Api.Policies (google_api_dns v0.29.0)
API calls for all endpoints tagged Policies
.
Summary
Functions
Creates a new Policy.
Deletes a previously created Policy. Fails if the policy is still being referenced by a network.
Fetches the representation of an existing Policy.
Enumerates all Policies associated with a project.
Applies a partial update to an existing Policy.
Updates an existing Policy.
Functions
Link to this function
dns_policies_create(connection, project, optional_params \\ [], opts \\ [])
View Source@spec dns_policies_create(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.DNS.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new Policy.
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.Policy.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.DNS.V1.Model.Policy{}}
on success -
{:error, info}
on failure
Link to this function
dns_policies_delete(connection, project, policy, optional_params \\ [], opts \\ [])
View Source@spec dns_policies_delete( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a previously created Policy. Fails if the policy is still being referenced by a network.
Parameters
-
connection
(type:GoogleApi.DNS.V1.Connection.t
) - Connection to server -
project
(type:String.t
) - Identifies the project addressed by this request. -
policy
(type:String.t
) - User given friendly name of the policy 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.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %{}}
on success -
{:error, info}
on failure
Link to this function
dns_policies_get(connection, project, policy, optional_params \\ [], opts \\ [])
View Source@spec dns_policies_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DNS.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Fetches the representation of an existing Policy.
Parameters
-
connection
(type:GoogleApi.DNS.V1.Connection.t
) - Connection to server -
project
(type:String.t
) - Identifies the project addressed by this request. -
policy
(type:String.t
) - User given friendly name of the policy 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.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.DNS.V1.Model.Policy{}}
on success -
{:error, info}
on failure
Link to this function
dns_policies_list(connection, project, optional_params \\ [], opts \\ [])
View Source@spec dns_policies_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.DNS.V1.Model.PoliciesListResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Enumerates all Policies associated with a project.
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"). -
: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.PoliciesListResponse{}}
on success -
{:error, info}
on failure
Link to this function
dns_policies_patch(connection, project, policy, optional_params \\ [], opts \\ [])
View Source@spec dns_policies_patch( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DNS.V1.Model.PoliciesPatchResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Applies a partial update to an existing Policy.
Parameters
-
connection
(type:GoogleApi.DNS.V1.Connection.t
) - Connection to server -
project
(type:String.t
) - Identifies the project addressed by this request. -
policy
(type:String.t
) - User given friendly name of the policy 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.Policy.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.DNS.V1.Model.PoliciesPatchResponse{}}
on success -
{:error, info}
on failure
Link to this function
dns_policies_update(connection, project, policy, optional_params \\ [], opts \\ [])
View Source@spec dns_policies_update( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DNS.V1.Model.PoliciesUpdateResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates an existing Policy.
Parameters
-
connection
(type:GoogleApi.DNS.V1.Connection.t
) - Connection to server -
project
(type:String.t
) - Identifies the project addressed by this request. -
policy
(type:String.t
) - User given friendly name of the policy 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.Policy.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.DNS.V1.Model.PoliciesUpdateResponse{}}
on success -
{:error, info}
on failure