Domains

import { Domains } from "https://googleapis.deno.dev/v1/domains:v1.ts";

Enables management and configuration of domain names.

class Domains {

constructor(client?: CredentialsClient, baseUrl?: string);

locations;

async projectsLocationsGet(name: string): Promise<Location>;

async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;

async projectsLocationsOperationsGet(name: string): Promise<Operation>;

async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>;

async projectsLocationsRegistrationsConfigureContactSettings(registration: string, req: ConfigureContactSettingsRequest): Promise<Operation>;

async projectsLocationsRegistrationsConfigureDnsSettings(registration: string, req: ConfigureDnsSettingsRequest): Promise<Operation>;

async projectsLocationsRegistrationsConfigureManagementSettings(registration: string, req: ConfigureManagementSettingsRequest): Promise<Operation>;

async projectsLocationsRegistrationsDelete(name: string): Promise<Operation>;

async projectsLocationsRegistrationsExport(name: string, req: ExportRegistrationRequest): Promise<Operation>;

async projectsLocationsRegistrationsGet(name: string): Promise<Registration>;

async projectsLocationsRegistrationsGetIamPolicy(resource: string, opts?: ProjectsLocationsRegistrationsGetIamPolicyOptions): Promise<Policy>;

async projectsLocationsRegistrationsImport(parent: string, req: ImportDomainRequest): Promise<Operation>;

async projectsLocationsRegistrationsList(parent: string, opts?: ProjectsLocationsRegistrationsListOptions): Promise<ListRegistrationsResponse>;

async projectsLocationsRegistrationsPatch(

name: string,

req: Registration,

opts?: ProjectsLocationsRegistrationsPatchOptions,

): Promise<Operation>;

async projectsLocationsRegistrationsRegister(parent: string, req: RegisterDomainRequest): Promise<Operation>;

async projectsLocationsRegistrationsResetAuthorizationCode(registration: string, req: ResetAuthorizationCodeRequest): Promise<AuthorizationCode>;

async projectsLocationsRegistrationsRetrieveAuthorizationCode(registration: string): Promise<AuthorizationCode>;

async projectsLocationsRegistrationsRetrieveImportableDomains(location: string, opts?: ProjectsLocationsRegistrationsRetrieveImportableDomainsOptions): Promise<RetrieveImportableDomainsResponse>;

async projectsLocationsRegistrationsRetrieveRegisterParameters(location: string, opts?: ProjectsLocationsRegistrationsRetrieveRegisterParametersOptions): Promise<RetrieveRegisterParametersResponse>;

async projectsLocationsRegistrationsRetrieveTransferParameters(location: string, opts?: ProjectsLocationsRegistrationsRetrieveTransferParametersOptions): Promise<RetrieveTransferParametersResponse>;

async projectsLocationsRegistrationsSearchDomains(location: string, opts?: ProjectsLocationsRegistrationsSearchDomainsOptions): Promise<SearchDomainsResponse>;

async projectsLocationsRegistrationsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsRegistrationsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsLocationsRegistrationsTransfer(parent: string, req: TransferDomainRequest): Promise<Operation>;

}

§Constructors

new Domains(client?: CredentialsClient, baseUrl?: string)

[src]

§Properties

locations

[src]

Updates a Registration's contact settings. Some changes require confirmation by the domain's registrant contact . Caution: Please consider carefully any changes to contact privacy settings when changing from REDACTED_CONTACT_DATA to PUBLIC_CONTACT_DATA. There may be a delay in reflecting updates you make to registrant contact information such that any changes you make to contact privacy (including from REDACTED_CONTACT_DATA to PUBLIC_CONTACT_DATA) will be applied without delay but changes to registrant contact information may take a limited time to be publicized. This means that changes to contact privacy from REDACTED_CONTACT_DATA to PUBLIC_CONTACT_DATA may make the previous registrant contact data public until the modified registrant contact details are published.

locations

[src]

Updates a Registration's DNS settings.

locations

[src]

Updates a Registration's management settings.

locations

[src]

Deletes a Registration resource. This method works on any Registration resource using Subscription or Commitment billing, provided that the resource was created at least 1 day in the past. When an active registration is successfully deleted, you can continue to use the domain in Google Domains until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains. After January 2024 you will only be able to delete Registration resources when state is one of: EXPORTED, EXPIRED,REGISTRATION_FAILED or TRANSFER_FAILED. See Cloud Domains feature deprecation for more details.

locations

[src]

Deprecated: For more information, see Cloud Domains feature deprecation Exports a Registration resource, such that it is no longer managed by Cloud Domains. When an active domain is successfully exported, you can continue to use the domain in Google Domains until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.

locations

[src]

Gets the details of a Registration resource.

locations

[src]

Deprecated: For more information, see Cloud Domains feature deprecation Imports a domain name from Google Domains for use in Cloud Domains. To transfer a domain from another registrar, use the TransferDomain method instead. Since individual users can own domains in Google Domains, the calling user must have ownership permission on the domain.

locations

[src]

Lists the Registration resources in a project.

locations

[src]

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

locations

[src]

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.

locations

[src]

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.

locations

[src]

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.

locations

[src]

Deprecated: For more information, see Cloud Domains feature deprecation Lists domain names from Google Domains that can be imported to Cloud Domains using the ImportDomain method. Since individual users can own domains in Google Domains, the list of domains returned depends on the individual user making the call. Domains already managed by Cloud Domains are not returned.

locations

[src]

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

locations

[src]

Deprecated: For more information, see Cloud Domains feature deprecation Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains already managed by Google Domains, use ImportDomain instead. Use the returned values to call TransferDomain.

locations

[src]

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.

locations

[src]

Deprecated: For more information, see Cloud Domains feature deprecation Transfers a domain name from another registrar to Cloud Domains. For domains already managed by Google Domains, use ImportDomain instead. Before calling this method, go to the domain's current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call RetrieveTransferParameters to confirm that the domain is unlocked and to get values needed to build a call to this method. A successful call creates a Registration resource in state TRANSFER_PENDING. It can take several days to complete the transfer process. The registrant can often speed up this process by approving the transfer through the current registrar, either by clicking a link in an email from the registrar or by visiting the registrar's website. A few minutes after transfer approval, the resource transitions to state ACTIVE, indicating that the transfer was successful. If the transfer is rejected or the request expires without being approved, the resource can end up in state TRANSFER_FAILED. If transfer fails, you can safely delete the resource and retry the transfer.

§Methods

projectsLocationsGet(name: string): Promise<Location>

[src]

Gets information about a location.

@param name

Resource name for the location.

projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>

[src]

Lists information about the supported locations for this service.

@param name

The resource that owns the locations collection, if applicable.

projectsLocationsOperationsGet(name: string): Promise<Operation>

[src]

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.

@param name

The name of the operation resource.

projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsLocationsRegistrationsConfigureContactSettings(registration: string, req: ConfigureContactSettingsRequest): Promise<Operation>

[src]

projectsLocationsRegistrationsConfigureDnsSettings(registration: string, req: ConfigureDnsSettingsRequest): Promise<Operation>

[src]

projectsLocationsRegistrationsConfigureManagementSettings(registration: string, req: ConfigureManagementSettingsRequest): Promise<Operation>

[src]

projectsLocationsRegistrationsDelete(name: string): Promise<Operation>

[src]

projectsLocationsRegistrationsExport(name: string, req: ExportRegistrationRequest): Promise<Operation>

[src]

projectsLocationsRegistrationsGet(name: string): Promise<Registration>

[src]

projectsLocationsRegistrationsGetIamPolicy(resource: string, opts?: ProjectsLocationsRegistrationsGetIamPolicyOptions): Promise<Policy>

[src]

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

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

projectsLocationsRegistrationsImport(parent: string, req: ImportDomainRequest): Promise<Operation>

[src]

projectsLocationsRegistrationsList(parent: string, opts?: ProjectsLocationsRegistrationsListOptions): Promise<ListRegistrationsResponse>

[src]

projectsLocationsRegistrationsPatch(name: string, req: Registration, opts?: ProjectsLocationsRegistrationsPatchOptions): Promise<Operation>

[src]

projectsLocationsRegistrationsRegister(parent: string, req: RegisterDomainRequest): Promise<Operation>

[src]

projectsLocationsRegistrationsResetAuthorizationCode(registration: string, req: ResetAuthorizationCodeRequest): Promise<AuthorizationCode>

[src]

projectsLocationsRegistrationsRetrieveAuthorizationCode(registration: string): Promise<AuthorizationCode>

[src]

projectsLocationsRegistrationsRetrieveImportableDomains(location: string, opts?: ProjectsLocationsRegistrationsRetrieveImportableDomainsOptions): Promise<RetrieveImportableDomainsResponse>

[src]

projectsLocationsRegistrationsRetrieveRegisterParameters(location: string, opts?: ProjectsLocationsRegistrationsRetrieveRegisterParametersOptions): Promise<RetrieveRegisterParametersResponse>

[src]

projectsLocationsRegistrationsRetrieveTransferParameters(location: string, opts?: ProjectsLocationsRegistrationsRetrieveTransferParametersOptions): Promise<RetrieveTransferParametersResponse>

[src]

projectsLocationsRegistrationsSearchDomains(location: string, opts?: ProjectsLocationsRegistrationsSearchDomainsOptions): Promise<SearchDomainsResponse>

[src]

projectsLocationsRegistrationsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

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

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

projectsLocationsRegistrationsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

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.

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

projectsLocationsRegistrationsTransfer(parent: string, req: TransferDomainRequest): Promise<Operation>

[src]