google_api_dns v0.14.0 GoogleApi.DNS.V1.Api.Policies View Source
API calls for all endpoints tagged Policies
.
Link to this section Summary
Functions
Create a new Policy
Delete a previously created Policy. Will fail if the policy is still being referenced by a network.
Fetch the representation of an existing Policy.
Enumerate all Policies associated with a project.
Apply a partial update to an existing Policy.
Update an existing Policy.
Link to this section Functions
dns_policies_create(connection, project, optional_params \\ [], opts \\ [])
View Sourcedns_policies_create(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.DNS.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Create a new Policy
Parameters
connection
(type:GoogleApi.DNS.V1.Connection.t
) - Connection to serverproject
(type:String.t
) - Identifies the project addressed by this request.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.: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
dns_policies_delete(connection, project, policy, optional_params \\ [], opts \\ [])
View Sourcedns_policies_delete( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}
Delete a previously created Policy. Will fail if the policy is still being referenced by a network.
Parameters
connection
(type:GoogleApi.DNS.V1.Connection.t
) - Connection to serverproject
(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: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.
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
dns_policies_get(connection, project, policy, optional_params \\ [], opts \\ [])
View Sourcedns_policies_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DNS.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Fetch the representation of an existing Policy.
Parameters
connection
(type:GoogleApi.DNS.V1.Connection.t
) - Connection to serverproject
(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: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.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.DNS.V1.Model.Policy{}}
on success{:error, info}
on failure
dns_policies_list(connection, project, optional_params \\ [], opts \\ [])
View Sourcedns_policies_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.DNS.V1.Model.PoliciesListResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Enumerate all Policies associated with a project.
Parameters
connection
(type:GoogleApi.DNS.V1.Connection.t
) - Connection to serverproject
(type:String.t
) - Identifies the project addressed by this request.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.: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.PoliciesListResponse{}}
on success{:error, info}
on failure
dns_policies_patch(connection, project, policy, optional_params \\ [], opts \\ [])
View Sourcedns_policies_patch( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DNS.V1.Model.PoliciesPatchResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Apply a partial update to an existing Policy.
Parameters
connection
(type:GoogleApi.DNS.V1.Connection.t
) - Connection to serverproject
(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: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.: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
dns_policies_update(connection, project, policy, optional_params \\ [], opts \\ [])
View Sourcedns_policies_update( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DNS.V1.Model.PoliciesUpdateResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Update an existing Policy.
Parameters
connection
(type:GoogleApi.DNS.V1.Connection.t
) - Connection to serverproject
(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: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.: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