google_api_dns v0.4.0 GoogleApi.DNS.V1.Api.ManagedZones View Source
API calls for all endpoints tagged ManagedZones
.
Link to this section Summary
Functions
Create a new ManagedZone.
Delete a previously created ManagedZone.
Fetch the representation of an existing ManagedZone.
Enumerate ManagedZones that have been created but not yet deleted.
Apply a partial update to an existing ManagedZone.
Update an existing ManagedZone.
Link to this section Functions
dns_managed_zones_create(connection, project, optional_params \\ [], opts \\ []) View Source
Create a new ManagedZone.
Parameters
- connection (GoogleApi.DNS.V1.Connection): Connection to server
- project (String.t): Identifies the project addressed by this request.
optional_params (keyword()): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :clientOperationId (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 (GoogleApi.DNS.V1.Model.ManagedZone.t):
Returns
{:ok, %GoogleApi.DNS.V1.Model.ManagedZone{}} on success {:error, info} on failure
dns_managed_zones_delete(connection, project, managed_zone, optional_params \\ [], opts \\ []) View Source
Delete a previously created ManagedZone.
Parameters
- connection (GoogleApi.DNS.V1.Connection): Connection to server
- project (String.t): Identifies the project addressed by this request.
- managed_zone (String.t): Identifies the managed zone addressed by this request. Can be the managed zone name or id.
optional_params (keyword()): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :clientOperationId (String.t): For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Returns
{:ok, %{}} on success {:error, info} on failure
dns_managed_zones_get(connection, project, managed_zone, optional_params \\ [], opts \\ []) View Source
Fetch the representation of an existing ManagedZone.
Parameters
- connection (GoogleApi.DNS.V1.Connection): Connection to server
- project (String.t): Identifies the project addressed by this request.
- managed_zone (String.t): Identifies the managed zone addressed by this request. Can be the managed zone name or id.
optional_params (keyword()): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :clientOperationId (String.t): For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Returns
{:ok, %GoogleApi.DNS.V1.Model.ManagedZone{}} on success {:error, info} on failure
dns_managed_zones_list(connection, project, optional_params \\ [], opts \\ []) View Source
Enumerate ManagedZones that have been created but not yet deleted.
Parameters
- connection (GoogleApi.DNS.V1.Connection): Connection to server
- project (String.t): Identifies the project addressed by this request.
optional_params (keyword()): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :dnsName (String.t): Restricts the list to return only zones with this domain name.
- :maxResults (integer()): Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
- :pageToken (String.t): Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
Returns
{:ok, %GoogleApi.DNS.V1.Model.ManagedZonesListResponse{}} on success {:error, info} on failure
dns_managed_zones_patch(connection, project, managed_zone, optional_params \\ [], opts \\ []) View Source
Apply a partial update to an existing ManagedZone.
Parameters
- connection (GoogleApi.DNS.V1.Connection): Connection to server
- project (String.t): Identifies the project addressed by this request.
- managed_zone (String.t): Identifies the managed zone addressed by this request. Can be the managed zone name or id.
optional_params (keyword()): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :clientOperationId (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 (GoogleApi.DNS.V1.Model.ManagedZone.t):
Returns
{:ok, %GoogleApi.DNS.V1.Model.Operation{}} on success {:error, info} on failure
dns_managed_zones_update(connection, project, managed_zone, optional_params \\ [], opts \\ []) View Source
Update an existing ManagedZone.
Parameters
- connection (GoogleApi.DNS.V1.Connection): Connection to server
- project (String.t): Identifies the project addressed by this request.
- managed_zone (String.t): Identifies the managed zone addressed by this request. Can be the managed zone name or id.
optional_params (keyword()): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :clientOperationId (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 (GoogleApi.DNS.V1.Model.ManagedZone.t):
Returns
{:ok, %GoogleApi.DNS.V1.Model.Operation{}} on success {:error, info} on failure