GoogleApi.Domains.V1alpha2.Api.Projects (google_api_domains v0.2.0) View Source
API calls for all endpoints tagged Projects
.
Link to this section Summary
Functions
Gets information about a location.
Lists information about the supported locations for this service.
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
. NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Updates a Registration
's contact settings. Some changes require confirmation by the domain's registrant contact .
Updates a Registration
's DNS settings.
Updates a Registration
's management settings.
Deletes a Registration
resource. This method only works on resources in one of the following states: state
is EXPORTED
with expire_time
in the past state
is REGISTRATION_FAILED
Exports a Registration
that you no longer want to use with Cloud Domains. You can continue to use the domain in Google Domains until it expires. If the export is successful: The resource's state
becomes EXPORTED
, meaning that it is no longer managed by Cloud Domains Because individual users can own domains in Google Domains, the calling user becomes the domain's sole owner. Permissions for the domain are subsequently managed in Google Domains. * Without further action, the domain does not renew automatically. The new owner can set up billing in Google Domains to renew the domain if needed.
Gets the details of a Registration
resource.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists the Registration
resources in a project.
Updates select fields of a Registration
resource, notably labels
. To update other fields, use the appropriate custom update method: To update management settings, see ConfigureManagementSettings
To update DNS configuration, see ConfigureDnsSettings
* To update contact information, see ConfigureContactSettings
Registers a new domain name and creates a corresponding Registration
resource. Call RetrieveRegisterParameters
first to check availability of the domain name and determine parameters like price that are needed to build a call to this method. A successful call creates a Registration
resource in state REGISTRATION_PENDING
, which resolves to ACTIVE
within 1-2 minutes, indicating that the domain was successfully registered. If the resource ends up in state REGISTRATION_FAILED
, it indicates that the domain was not registered successfully, and you can safely delete the resource and retry registration.
Resets the authorization code of the Registration
to a new random string. You can call this method only after 60 days have elapsed since the initial domain registration.
Gets the authorization code of the Registration
for the purpose of transferring the domain to another registrar. You can call this method only after 60 days have elapsed since the initial domain registration.
Gets parameters needed to register a new domain name, including price and up-to-date availability. Use the returned values to call RegisterDomain
.
Searches for available domain names similar to the provided query. Availability results from this method are approximate; call RetrieveRegisterParameters
on a domain before registering to confirm availability.
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND
error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Link to this section Functions
domains_projects_locations_get(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
domains_projects_locations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Domains.V1alpha2.Model.Location.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets information about a location.
Parameters
-
connection
(type:GoogleApi.Domains.V1alpha2.Connection.t
) - Connection to server -
name
(type:String.t
) - Resource name for the location. -
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").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Domains.V1alpha2.Model.Location{}}
on success -
{:error, info}
on failure
domains_projects_locations_list(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
domains_projects_locations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Domains.V1alpha2.Model.ListLocationsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists information about the supported locations for this service.
Parameters
-
connection
(type:GoogleApi.Domains.V1alpha2.Connection.t
) - Connection to server -
name
(type:String.t
) - The resource that owns the locations collection, if applicable. -
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"). -
:filter
(type:String.t
) - The standard list filter. -
:pageSize
(type:integer()
) - The standard list page size. -
:pageToken
(type:String.t
) - The standard list page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Domains.V1alpha2.Model.ListLocationsResponse{}}
on success -
{:error, info}
on failure
domains_projects_locations_operations_get(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
domains_projects_locations_operations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Domains.V1alpha2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters
-
connection
(type:GoogleApi.Domains.V1alpha2.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation resource. -
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").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Domains.V1alpha2.Model.Operation{}}
on success -
{:error, info}
on failure
domains_projects_locations_operations_list(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
domains_projects_locations_operations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Domains.V1alpha2.Model.ListOperationsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
. NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters
-
connection
(type:GoogleApi.Domains.V1alpha2.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation's parent resource. -
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"). -
:filter
(type:String.t
) - The standard list filter. -
:pageSize
(type:integer()
) - The standard list page size. -
:pageToken
(type:String.t
) - The standard list page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Domains.V1alpha2.Model.ListOperationsResponse{}}
on success -
{:error, info}
on failure
domains_projects_locations_registrations_configure_contact_settings(connection, registration, optional_params \\ [], opts \\ [])
View SourceSpecs
domains_projects_locations_registrations_configure_contact_settings( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Domains.V1alpha2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates a Registration
's contact settings. Some changes require confirmation by the domain's registrant contact .
Parameters
-
connection
(type:GoogleApi.Domains.V1alpha2.Connection.t
) - Connection to server -
registration
(type:String.t
) - Required. The name of theRegistration
whose contact settings are being updated, in the formatprojects/*/locations/*/registrations/*
. -
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"). -
:body
(type:GoogleApi.Domains.V1alpha2.Model.ConfigureContactSettingsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Domains.V1alpha2.Model.Operation{}}
on success -
{:error, info}
on failure
domains_projects_locations_registrations_configure_dns_settings(connection, registration, optional_params \\ [], opts \\ [])
View SourceSpecs
domains_projects_locations_registrations_configure_dns_settings( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Domains.V1alpha2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates a Registration
's DNS settings.
Parameters
-
connection
(type:GoogleApi.Domains.V1alpha2.Connection.t
) - Connection to server -
registration
(type:String.t
) - Required. The name of theRegistration
whose DNS settings are being updated, in the formatprojects/*/locations/*/registrations/*
. -
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"). -
:body
(type:GoogleApi.Domains.V1alpha2.Model.ConfigureDnsSettingsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Domains.V1alpha2.Model.Operation{}}
on success -
{:error, info}
on failure
domains_projects_locations_registrations_configure_management_settings(connection, registration, optional_params \\ [], opts \\ [])
View SourceSpecs
domains_projects_locations_registrations_configure_management_settings( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Domains.V1alpha2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates a Registration
's management settings.
Parameters
-
connection
(type:GoogleApi.Domains.V1alpha2.Connection.t
) - Connection to server -
registration
(type:String.t
) - Required. The name of theRegistration
whose management settings are being updated, in the formatprojects/*/locations/*/registrations/*
. -
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"). -
:body
(type:GoogleApi.Domains.V1alpha2.Model.ConfigureManagementSettingsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Domains.V1alpha2.Model.Operation{}}
on success -
{:error, info}
on failure
domains_projects_locations_registrations_delete(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
domains_projects_locations_registrations_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Domains.V1alpha2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Deletes a Registration
resource. This method only works on resources in one of the following states: state
is EXPORTED
with expire_time
in the past state
is REGISTRATION_FAILED
Parameters
-
connection
(type:GoogleApi.Domains.V1alpha2.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of theRegistration
to delete, in the formatprojects/*/locations/*/registrations/*
. -
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").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Domains.V1alpha2.Model.Operation{}}
on success -
{:error, info}
on failure
domains_projects_locations_registrations_export(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
domains_projects_locations_registrations_export( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Domains.V1alpha2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Exports a Registration
that you no longer want to use with Cloud Domains. You can continue to use the domain in Google Domains until it expires. If the export is successful: The resource's state
becomes EXPORTED
, meaning that it is no longer managed by Cloud Domains Because individual users can own domains in Google Domains, the calling user becomes the domain's sole owner. Permissions for the domain are subsequently managed in Google Domains. * Without further action, the domain does not renew automatically. The new owner can set up billing in Google Domains to renew the domain if needed.
Parameters
-
connection
(type:GoogleApi.Domains.V1alpha2.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of theRegistration
to export, in the formatprojects/*/locations/*/registrations/*
. -
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"). -
:body
(type:GoogleApi.Domains.V1alpha2.Model.ExportRegistrationRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Domains.V1alpha2.Model.Operation{}}
on success -
{:error, info}
on failure
domains_projects_locations_registrations_get(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
domains_projects_locations_registrations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Domains.V1alpha2.Model.Registration.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets the details of a Registration
resource.
Parameters
-
connection
(type:GoogleApi.Domains.V1alpha2.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of theRegistration
to get, in the formatprojects/*/locations/*/registrations/*
. -
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").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Domains.V1alpha2.Model.Registration{}}
on success -
{:error, info}
on failure
domains_projects_locations_registrations_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View SourceSpecs
domains_projects_locations_registrations_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Domains.V1alpha2.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection
(type:GoogleApi.Domains.V1alpha2.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. -
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"). -
:"options.requestedPolicyVersion"
(type:integer()
) - Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Domains.V1alpha2.Model.Policy{}}
on success -
{:error, info}
on failure
domains_projects_locations_registrations_list(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
domains_projects_locations_registrations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Domains.V1alpha2.Model.ListRegistrationsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists the Registration
resources in a project.
Parameters
-
connection
(type:GoogleApi.Domains.V1alpha2.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The project and location from which to listRegistration
s, specified in the formatprojects/*/locations/*
. -
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"). -
:filter
(type:String.t
) - Filter expression to restrict theRegistration
s returned. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, a boolean, or an enum value. The comparison operator should be one of =, !=, >, <, >=, <=, or : for prefix or wildcard matches. For example, to filter to a specific domain name, use an expression likedomainName="example.com"
. You can also check for the existence of a field; for example, to find domains using custom DNS settings, use an expression likednsSettings.customDns:*
. You can also create compound filters by combining expressions with theAND
andOR
operators. For example, to find domains that are suspended or have specific issues flagged, use an expression like(state=SUSPENDED) OR (issue:*)
. -
:pageSize
(type:integer()
) - Maximum number of results to return. -
:pageToken
(type:String.t
) - When set to thenext_page_token
from a prior response, provides the next page of results.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Domains.V1alpha2.Model.ListRegistrationsResponse{}}
on success -
{:error, info}
on failure
domains_projects_locations_registrations_patch(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
domains_projects_locations_registrations_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Domains.V1alpha2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates select fields of a Registration
resource, notably labels
. To update other fields, use the appropriate custom update method: To update management settings, see ConfigureManagementSettings
To update DNS configuration, see ConfigureDnsSettings
* To update contact information, see ConfigureContactSettings
Parameters
-
connection
(type:GoogleApi.Domains.V1alpha2.Connection.t
) - Connection to server -
name
(type:String.t
) - Output only. Name of theRegistration
resource, in the formatprojects/*/locations/*/registrations/
. -
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"). -
:updateMask
(type:String.t
) - Required. The field mask describing which fields to update as a comma-separated list. For example, if only the labels are being updated, theupdate_mask
would be"labels"
. -
:body
(type:GoogleApi.Domains.V1alpha2.Model.Registration.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Domains.V1alpha2.Model.Operation{}}
on success -
{:error, info}
on failure
domains_projects_locations_registrations_register(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
domains_projects_locations_registrations_register( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Domains.V1alpha2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Registers a new domain name and creates a corresponding Registration
resource. Call RetrieveRegisterParameters
first to check availability of the domain name and determine parameters like price that are needed to build a call to this method. A successful call creates a Registration
resource in state REGISTRATION_PENDING
, which resolves to ACTIVE
within 1-2 minutes, indicating that the domain was successfully registered. If the resource ends up in state REGISTRATION_FAILED
, it indicates that the domain was not registered successfully, and you can safely delete the resource and retry registration.
Parameters
-
connection
(type:GoogleApi.Domains.V1alpha2.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent resource of theRegistration
. Must be in the formatprojects/*/locations/*
. -
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"). -
:body
(type:GoogleApi.Domains.V1alpha2.Model.RegisterDomainRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Domains.V1alpha2.Model.Operation{}}
on success -
{:error, info}
on failure
domains_projects_locations_registrations_reset_authorization_code(connection, registration, optional_params \\ [], opts \\ [])
View SourceSpecs
domains_projects_locations_registrations_reset_authorization_code( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Domains.V1alpha2.Model.AuthorizationCode.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Resets the authorization code of the Registration
to a new random string. You can call this method only after 60 days have elapsed since the initial domain registration.
Parameters
-
connection
(type:GoogleApi.Domains.V1alpha2.Connection.t
) - Connection to server -
registration
(type:String.t
) - Required. The name of theRegistration
whose authorization code is being reset, in the formatprojects/*/locations/*/registrations/*
. -
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"). -
:body
(type:GoogleApi.Domains.V1alpha2.Model.ResetAuthorizationCodeRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Domains.V1alpha2.Model.AuthorizationCode{}}
on success -
{:error, info}
on failure
domains_projects_locations_registrations_retrieve_authorization_code(connection, registration, optional_params \\ [], opts \\ [])
View SourceSpecs
domains_projects_locations_registrations_retrieve_authorization_code( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Domains.V1alpha2.Model.AuthorizationCode.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets the authorization code of the Registration
for the purpose of transferring the domain to another registrar. You can call this method only after 60 days have elapsed since the initial domain registration.
Parameters
-
connection
(type:GoogleApi.Domains.V1alpha2.Connection.t
) - Connection to server -
registration
(type:String.t
) - Required. The name of theRegistration
whose authorization code is being retrieved, in the formatprojects/*/locations/*/registrations/*
. -
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").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Domains.V1alpha2.Model.AuthorizationCode{}}
on success -
{:error, info}
on failure
domains_projects_locations_registrations_retrieve_register_parameters(connection, location, optional_params \\ [], opts \\ [])
View SourceSpecs
domains_projects_locations_registrations_retrieve_register_parameters( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Domains.V1alpha2.Model.RetrieveRegisterParametersResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets parameters needed to register a new domain name, including price and up-to-date availability. Use the returned values to call RegisterDomain
.
Parameters
-
connection
(type:GoogleApi.Domains.V1alpha2.Connection.t
) - Connection to server -
location
(type:String.t
) - Required. The location. Must be in the formatprojects/*/locations/*
. -
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"). -
:domainName
(type:String.t
) - Required. The domain name. Unicode domain names must be expressed in Punycode format.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Domains.V1alpha2.Model.RetrieveRegisterParametersResponse{}}
on success -
{:error, info}
on failure
domains_projects_locations_registrations_search_domains(connection, location, optional_params \\ [], opts \\ [])
View SourceSpecs
domains_projects_locations_registrations_search_domains( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Domains.V1alpha2.Model.SearchDomainsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Searches for available domain names similar to the provided query. Availability results from this method are approximate; call RetrieveRegisterParameters
on a domain before registering to confirm availability.
Parameters
-
connection
(type:GoogleApi.Domains.V1alpha2.Connection.t
) - Connection to server -
location
(type:String.t
) - Required. The location. Must be in the formatprojects/*/locations/*
. -
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"). -
:query
(type:String.t
) - Required. String used to search for available domain names.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Domains.V1alpha2.Model.SearchDomainsResponse{}}
on success -
{:error, info}
on failure
domains_projects_locations_registrations_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View SourceSpecs
domains_projects_locations_registrations_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Domains.V1alpha2.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Parameters
-
connection
(type:GoogleApi.Domains.V1alpha2.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. -
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"). -
:body
(type:GoogleApi.Domains.V1alpha2.Model.SetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Domains.V1alpha2.Model.Policy{}}
on success -
{:error, info}
on failure
domains_projects_locations_registrations_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
View SourceSpecs
domains_projects_locations_registrations_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Domains.V1alpha2.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND
error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters
-
connection
(type:GoogleApi.Domains.V1alpha2.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. -
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"). -
:body
(type:GoogleApi.Domains.V1alpha2.Model.TestIamPermissionsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Domains.V1alpha2.Model.TestIamPermissionsResponse{}}
on success -
{:error, info}
on failure