Liking cljdoc? Tell your friends :D

happygapi.domains.projects

Cloud Domains API: projects. Enables management and configuration of domain names. See: https://cloud.google.com/domains/api/reference/rest/v1beta1/projects

Cloud Domains API: projects.
Enables management and configuration of domain names.
See: https://cloud.google.com/domains/api/reference/rest/v1beta1/projects
raw docstring

locations-get$clj

(locations-get$ auth parameters)

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/get

Required parameters: name

Optional parameters: none

Gets information about a location.

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/get

Required parameters: name

Optional parameters: none

Gets information about a location.
sourceraw docstring

locations-list$clj

(locations-list$ auth parameters)

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/list

Required parameters: name

Optional parameters: pageToken, filter, pageSize

Lists information about the supported locations for this service.

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/list

Required parameters: name

Optional parameters: pageToken, filter, pageSize

Lists information about the supported locations for this service.
sourceraw docstring

locations-operations-get$clj

(locations-operations-get$ auth parameters)

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/operations/get

Required parameters: name

Optional parameters: none

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.

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/operations/get

Required parameters: name

Optional parameters: none

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.
sourceraw docstring

locations-operations-list$clj

(locations-operations-list$ auth parameters)

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/operations/list

Required parameters: name

Optional parameters: filter, pageToken, pageSize

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.

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/operations/list

Required parameters: name

Optional parameters: filter, pageToken, pageSize

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.
sourceraw docstring

locations-registrations-configureContactSettings$clj

(locations-registrations-configureContactSettings$ auth parameters body)

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/configureContactSettings

Required parameters: registration

Optional parameters: none

Body:

{:contactNotices [string], :updateMask string, :validateOnly boolean, :contactSettings {:technicalContact Contact, :adminContact Contact, :registrantContact Contact, :privacy string}}

Updates a Registration's contact settings. Some changes require confirmation by the domain's registrant contact .

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/configureContactSettings

Required parameters: registration

Optional parameters: none

Body: 

{:contactNotices [string],
 :updateMask string,
 :validateOnly boolean,
 :contactSettings {:technicalContact Contact,
                   :adminContact Contact,
                   :registrantContact Contact,
                   :privacy string}}

Updates a `Registration`'s contact settings. Some changes require confirmation by the domain's registrant contact .
sourceraw docstring

locations-registrations-configureDnsSettings$clj

(locations-registrations-configureDnsSettings$ auth parameters body)

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/configureDnsSettings

Required parameters: registration

Optional parameters: none

Body:

{:validateOnly boolean, :dnsSettings {:customDns CustomDns, :googleDomainsDns GoogleDomainsDns, :glueRecords [GlueRecord]}, :updateMask string}

Updates a Registration's DNS settings.

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/configureDnsSettings

Required parameters: registration

Optional parameters: none

Body: 

{:validateOnly boolean,
 :dnsSettings {:customDns CustomDns,
               :googleDomainsDns GoogleDomainsDns,
               :glueRecords [GlueRecord]},
 :updateMask string}

Updates a `Registration`'s DNS settings.
sourceraw docstring

locations-registrations-configureManagementSettings$clj

(locations-registrations-configureManagementSettings$ auth parameters body)

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/configureManagementSettings

Required parameters: registration

Optional parameters: none

Body:

{:updateMask string, :managementSettings {:transferLockState string, :renewalMethod string}}

Updates a Registration's management settings.

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/configureManagementSettings

Required parameters: registration

Optional parameters: none

Body: 

{:updateMask string,
 :managementSettings {:transferLockState string,
                      :renewalMethod string}}

Updates a `Registration`'s management settings.
sourceraw docstring

locations-registrations-delete$clj

(locations-registrations-delete$ auth parameters)

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/delete

Required parameters: name

Optional parameters: none

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

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/delete

Required parameters: name

Optional parameters: none

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`
sourceraw docstring

locations-registrations-export$clj

(locations-registrations-export$ auth parameters body)

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/export

Required parameters: name

Optional parameters: none

Body:

{}

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.

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/export

Required parameters: name

Optional parameters: none

Body: 

{}

Exports a `Registration` that you no longer want to use with Cloud Domains. You can continue to use the domain in [Google Domains](https://domains.google/) 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.
sourceraw docstring

locations-registrations-get$clj

(locations-registrations-get$ auth parameters)

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/get

Required parameters: name

Optional parameters: none

Gets the details of a Registration resource.

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/get

Required parameters: name

Optional parameters: none

Gets the details of a `Registration` resource.
sourceraw docstring

locations-registrations-getIamPolicy$clj

(locations-registrations-getIamPolicy$ auth parameters)

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/getIamPolicy

Required parameters: resource

Optional parameters: options.requestedPolicyVersion

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/getIamPolicy

Required parameters: resource

Optional parameters: options.requestedPolicyVersion

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
sourceraw docstring

locations-registrations-list$clj

(locations-registrations-list$ auth parameters)

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/list

Required parameters: parent

Optional parameters: pageSize, pageToken, filter

Lists the Registration resources in a project.

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/list

Required parameters: parent

Optional parameters: pageSize, pageToken, filter

Lists the `Registration` resources in a project.
sourceraw docstring

locations-registrations-patch$clj

(locations-registrations-patch$ auth parameters body)

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:labels {}, :supportedPrivacy [string], :dnsSettings {:customDns CustomDns, :googleDomainsDns GoogleDomainsDns, :glueRecords [GlueRecord]}, :issues [string], :name string, :createTime string, :managementSettings {:transferLockState string, :renewalMethod string}, :contactSettings {:technicalContact Contact, :adminContact Contact, :registrantContact Contact, :privacy string}, :state string, :domainName string, :expireTime string, :pendingContactSettings {:technicalContact Contact, :adminContact Contact, :registrantContact Contact, :privacy string}}

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

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/patch

Required parameters: name

Optional parameters: updateMask

Body: 

{:labels {},
 :supportedPrivacy [string],
 :dnsSettings {:customDns CustomDns,
               :googleDomainsDns GoogleDomainsDns,
               :glueRecords [GlueRecord]},
 :issues [string],
 :name string,
 :createTime string,
 :managementSettings {:transferLockState string,
                      :renewalMethod string},
 :contactSettings {:technicalContact Contact,
                   :adminContact Contact,
                   :registrantContact Contact,
                   :privacy string},
 :state string,
 :domainName string,
 :expireTime string,
 :pendingContactSettings {:technicalContact Contact,
                          :adminContact Contact,
                          :registrantContact Contact,
                          :privacy string}}

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`
sourceraw docstring

locations-registrations-register$clj

(locations-registrations-register$ auth parameters body)

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/register

Required parameters: parent

Optional parameters: none

Body:

{:contactNotices [string], :domainNotices [string], :registration {:labels {}, :supportedPrivacy [string], :dnsSettings DnsSettings, :issues [string], :name string, :createTime string, :managementSettings ManagementSettings, :contactSettings ContactSettings, :state string, :domainName string, :expireTime string, :pendingContactSettings ContactSettings}, :yearlyPrice {:currencyCode string, :units string, :nanos integer}, :validateOnly boolean}

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.

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/register

Required parameters: parent

Optional parameters: none

Body: 

{:contactNotices [string],
 :domainNotices [string],
 :registration {:labels {},
                :supportedPrivacy [string],
                :dnsSettings DnsSettings,
                :issues [string],
                :name string,
                :createTime string,
                :managementSettings ManagementSettings,
                :contactSettings ContactSettings,
                :state string,
                :domainName string,
                :expireTime string,
                :pendingContactSettings ContactSettings},
 :yearlyPrice {:currencyCode string, :units string, :nanos integer},
 :validateOnly boolean}

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.
sourceraw docstring

locations-registrations-resetAuthorizationCode$clj

(locations-registrations-resetAuthorizationCode$ auth parameters body)

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/resetAuthorizationCode

Required parameters: registration

Optional parameters: none

Body:

{}

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.

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/resetAuthorizationCode

Required parameters: registration

Optional parameters: none

Body: 

{}

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.
sourceraw docstring

locations-registrations-retrieveAuthorizationCode$clj

(locations-registrations-retrieveAuthorizationCode$ auth parameters)

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/retrieveAuthorizationCode

Required parameters: registration

Optional parameters: none

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.

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/retrieveAuthorizationCode

Required parameters: registration

Optional parameters: none

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.
sourceraw docstring

locations-registrations-retrieveRegisterParameters$clj

(locations-registrations-retrieveRegisterParameters$ auth parameters)

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/retrieveRegisterParameters

Required parameters: location

Optional parameters: domainName

Gets parameters needed to register a new domain name, including price and up-to-date availability. Use the returned values to call RegisterDomain.

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/retrieveRegisterParameters

Required parameters: location

Optional parameters: domainName

Gets parameters needed to register a new domain name, including price and up-to-date availability. Use the returned values to call `RegisterDomain`.
sourceraw docstring

locations-registrations-searchDomains$clj

(locations-registrations-searchDomains$ auth parameters)

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/searchDomains

Required parameters: location

Optional parameters: query

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.

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/searchDomains

Required parameters: location

Optional parameters: query

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.
sourceraw docstring

locations-registrations-setIamPolicy$clj

(locations-registrations-setIamPolicy$ auth parameters body)

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/setIamPolicy

Required parameters: resource

Optional parameters: none

Body:

{:updateMask string, :policy {:auditConfigs [AuditConfig], :bindings [Binding], :etag string, :version integer}}

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/setIamPolicy

Required parameters: resource

Optional parameters: none

Body: 

{:updateMask string,
 :policy {:auditConfigs [AuditConfig],
          :bindings [Binding],
          :etag string,
          :version integer}}

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
sourceraw docstring

locations-registrations-testIamPermissions$clj

(locations-registrations-testIamPermissions$ auth parameters body)

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/testIamPermissions

Required parameters: resource

Optional parameters: none

Body:

{:permissions [string]}

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.

https://cloud.google.com/domains/api/reference/rest/v1beta1/projects/locations/registrations/testIamPermissions

Required parameters: resource

Optional parameters: none

Body: 

{:permissions [string]}

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.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close