Cloud Domains v1 API - Class DomainsClient (2.3.0)

public abstract class DomainsClient

Reference documentation and code samples for the Cloud Domains v1 API class DomainsClient.

Domains client wrapper, for convenient use.

Inheritance

object > DomainsClient

Derived Types

Namespace

Google.Cloud.Domains.V1

Assembly

Google.Cloud.Domains.V1.dll

Remarks

The Cloud Domains API enables management and configuration of domain names.

Properties

ConfigureContactSettingsOperationsClient

public virtual OperationsClient ConfigureContactSettingsOperationsClient { get; }

The long-running operations client for ConfigureContactSettings.

Property Value
Type Description
OperationsClient

ConfigureDnsSettingsOperationsClient

public virtual OperationsClient ConfigureDnsSettingsOperationsClient { get; }

The long-running operations client for ConfigureDnsSettings.

Property Value
Type Description
OperationsClient

ConfigureManagementSettingsOperationsClient

public virtual OperationsClient ConfigureManagementSettingsOperationsClient { get; }

The long-running operations client for ConfigureManagementSettings.

Property Value
Type Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the Domains service, which is a host of "domains.googleapis.com" and a port of 443.

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default Domains scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default Domains scopes are:

DeleteRegistrationOperationsClient

public virtual OperationsClient DeleteRegistrationOperationsClient { get; }

The long-running operations client for DeleteRegistration.

Property Value
Type Description
OperationsClient

ExportRegistrationOperationsClient

public virtual OperationsClient ExportRegistrationOperationsClient { get; }

The long-running operations client for ExportRegistration.

Property Value
Type Description
OperationsClient

GrpcClient

public virtual Domains.DomainsClient GrpcClient { get; }

The underlying gRPC Domains client

Property Value
Type Description
DomainsDomainsClient

RegisterDomainOperationsClient

public virtual OperationsClient RegisterDomainOperationsClient { get; }

The long-running operations client for RegisterDomain.

Property Value
Type Description
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

TransferDomainOperationsClient

public virtual OperationsClient TransferDomainOperationsClient { get; }

The long-running operations client for TransferDomain.

Property Value
Type Description
OperationsClient

UpdateRegistrationOperationsClient

public virtual OperationsClient UpdateRegistrationOperationsClient { get; }

The long-running operations client for UpdateRegistration.

Property Value
Type Description
OperationsClient

Methods

ConfigureContactSettings(ConfigureContactSettingsRequest, CallSettings)

public virtual Operation<Registration, OperationMetadata> ConfigureContactSettings(ConfigureContactSettingsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ConfigureContactSettingsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
ConfigureContactSettingsRequest request = new ConfigureContactSettingsRequest
{
    RegistrationAsRegistrationName = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]"),
    ContactSettings = new ContactSettings(),
    UpdateMask = new FieldMask(),
    ContactNotices =
    {
        ContactNotice.Unspecified,
    },
    ValidateOnly = false,
};
// Make the request
Operation<Registration, OperationMetadata> response = domainsClient.ConfigureContactSettings(request);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = domainsClient.PollOnceConfigureContactSettings(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureContactSettings(RegistrationName, ContactSettings, FieldMask, CallSettings)

public virtual Operation<Registration, OperationMetadata> ConfigureContactSettings(RegistrationName registration, ContactSettings contactSettings, FieldMask updateMask, CallSettings callSettings = null)

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

Parameters
Name Description
registration RegistrationName

Required. The name of the Registration whose contact settings are being updated, in the format projects/*/locations/*/registrations/*.

contactSettings ContactSettings

Fields of the ContactSettings to update.

updateMask FieldMask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the registrant contact is being updated, the update_mask is "registrant_contact".

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
RegistrationName registration = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
ContactSettings contactSettings = new ContactSettings();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Registration, OperationMetadata> response = domainsClient.ConfigureContactSettings(registration, contactSettings, updateMask);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = domainsClient.PollOnceConfigureContactSettings(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureContactSettings(string, ContactSettings, FieldMask, CallSettings)

public virtual Operation<Registration, OperationMetadata> ConfigureContactSettings(string registration, ContactSettings contactSettings, FieldMask updateMask, CallSettings callSettings = null)

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

Parameters
Name Description
registration string

Required. The name of the Registration whose contact settings are being updated, in the format projects/*/locations/*/registrations/*.

contactSettings ContactSettings

Fields of the ContactSettings to update.

updateMask FieldMask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the registrant contact is being updated, the update_mask is "registrant_contact".

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
string registration = "projects/[PROJECT]/locations/[LOCATION]/registrations/[REGISTRATION]";
ContactSettings contactSettings = new ContactSettings();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Registration, OperationMetadata> response = domainsClient.ConfigureContactSettings(registration, contactSettings, updateMask);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = domainsClient.PollOnceConfigureContactSettings(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureContactSettingsAsync(ConfigureContactSettingsRequest, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> ConfigureContactSettingsAsync(ConfigureContactSettingsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ConfigureContactSettingsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
ConfigureContactSettingsRequest request = new ConfigureContactSettingsRequest
{
    RegistrationAsRegistrationName = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]"),
    ContactSettings = new ContactSettings(),
    UpdateMask = new FieldMask(),
    ContactNotices =
    {
        ContactNotice.Unspecified,
    },
    ValidateOnly = false,
};
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.ConfigureContactSettingsAsync(request);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceConfigureContactSettingsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureContactSettingsAsync(ConfigureContactSettingsRequest, CancellationToken)

public virtual Task<Operation<Registration, OperationMetadata>> ConfigureContactSettingsAsync(ConfigureContactSettingsRequest request, CancellationToken cancellationToken)

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

Parameters
Name Description
request ConfigureContactSettingsRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
ConfigureContactSettingsRequest request = new ConfigureContactSettingsRequest
{
    RegistrationAsRegistrationName = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]"),
    ContactSettings = new ContactSettings(),
    UpdateMask = new FieldMask(),
    ContactNotices =
    {
        ContactNotice.Unspecified,
    },
    ValidateOnly = false,
};
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.ConfigureContactSettingsAsync(request);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceConfigureContactSettingsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureContactSettingsAsync(RegistrationName, ContactSettings, FieldMask, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> ConfigureContactSettingsAsync(RegistrationName registration, ContactSettings contactSettings, FieldMask updateMask, CallSettings callSettings = null)

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

Parameters
Name Description
registration RegistrationName

Required. The name of the Registration whose contact settings are being updated, in the format projects/*/locations/*/registrations/*.

contactSettings ContactSettings

Fields of the ContactSettings to update.

updateMask FieldMask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the registrant contact is being updated, the update_mask is "registrant_contact".

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
RegistrationName registration = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
ContactSettings contactSettings = new ContactSettings();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.ConfigureContactSettingsAsync(registration, contactSettings, updateMask);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceConfigureContactSettingsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureContactSettingsAsync(RegistrationName, ContactSettings, FieldMask, CancellationToken)

public virtual Task<Operation<Registration, OperationMetadata>> ConfigureContactSettingsAsync(RegistrationName registration, ContactSettings contactSettings, FieldMask updateMask, CancellationToken cancellationToken)

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

Parameters
Name Description
registration RegistrationName

Required. The name of the Registration whose contact settings are being updated, in the format projects/*/locations/*/registrations/*.

contactSettings ContactSettings

Fields of the ContactSettings to update.

updateMask FieldMask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the registrant contact is being updated, the update_mask is "registrant_contact".

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
RegistrationName registration = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
ContactSettings contactSettings = new ContactSettings();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.ConfigureContactSettingsAsync(registration, contactSettings, updateMask);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceConfigureContactSettingsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureContactSettingsAsync(string, ContactSettings, FieldMask, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> ConfigureContactSettingsAsync(string registration, ContactSettings contactSettings, FieldMask updateMask, CallSettings callSettings = null)

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

Parameters
Name Description
registration string

Required. The name of the Registration whose contact settings are being updated, in the format projects/*/locations/*/registrations/*.

contactSettings ContactSettings

Fields of the ContactSettings to update.

updateMask FieldMask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the registrant contact is being updated, the update_mask is "registrant_contact".

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string registration = "projects/[PROJECT]/locations/[LOCATION]/registrations/[REGISTRATION]";
ContactSettings contactSettings = new ContactSettings();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.ConfigureContactSettingsAsync(registration, contactSettings, updateMask);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceConfigureContactSettingsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureContactSettingsAsync(string, ContactSettings, FieldMask, CancellationToken)

public virtual Task<Operation<Registration, OperationMetadata>> ConfigureContactSettingsAsync(string registration, ContactSettings contactSettings, FieldMask updateMask, CancellationToken cancellationToken)

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

Parameters
Name Description
registration string

Required. The name of the Registration whose contact settings are being updated, in the format projects/*/locations/*/registrations/*.

contactSettings ContactSettings

Fields of the ContactSettings to update.

updateMask FieldMask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the registrant contact is being updated, the update_mask is "registrant_contact".

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string registration = "projects/[PROJECT]/locations/[LOCATION]/registrations/[REGISTRATION]";
ContactSettings contactSettings = new ContactSettings();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.ConfigureContactSettingsAsync(registration, contactSettings, updateMask);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceConfigureContactSettingsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureDnsSettings(ConfigureDnsSettingsRequest, CallSettings)

public virtual Operation<Registration, OperationMetadata> ConfigureDnsSettings(ConfigureDnsSettingsRequest request, CallSettings callSettings = null)

Updates a Registration's DNS settings.

Parameters
Name Description
request ConfigureDnsSettingsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
ConfigureDnsSettingsRequest request = new ConfigureDnsSettingsRequest
{
    RegistrationAsRegistrationName = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]"),
    DnsSettings = new DnsSettings(),
    UpdateMask = new FieldMask(),
    ValidateOnly = false,
};
// Make the request
Operation<Registration, OperationMetadata> response = domainsClient.ConfigureDnsSettings(request);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = domainsClient.PollOnceConfigureDnsSettings(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureDnsSettings(RegistrationName, DnsSettings, FieldMask, CallSettings)

public virtual Operation<Registration, OperationMetadata> ConfigureDnsSettings(RegistrationName registration, DnsSettings dnsSettings, FieldMask updateMask, CallSettings callSettings = null)

Updates a Registration's DNS settings.

Parameters
Name Description
registration RegistrationName

Required. The name of the Registration whose DNS settings are being updated, in the format projects/*/locations/*/registrations/*.

dnsSettings DnsSettings

Fields of the DnsSettings to update.

updateMask FieldMask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the name servers are being updated for an existing Custom DNS configuration, the update_mask is "custom_dns.name_servers".

When changing the DNS provider from one type to another, pass the new provider's field name as part of the field mask. For example, when changing from a Google Domains DNS configuration to a Custom DNS configuration, the update_mask is "custom_dns". //

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
RegistrationName registration = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
DnsSettings dnsSettings = new DnsSettings();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Registration, OperationMetadata> response = domainsClient.ConfigureDnsSettings(registration, dnsSettings, updateMask);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = domainsClient.PollOnceConfigureDnsSettings(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureDnsSettings(string, DnsSettings, FieldMask, CallSettings)

public virtual Operation<Registration, OperationMetadata> ConfigureDnsSettings(string registration, DnsSettings dnsSettings, FieldMask updateMask, CallSettings callSettings = null)

Updates a Registration's DNS settings.

Parameters
Name Description
registration string

Required. The name of the Registration whose DNS settings are being updated, in the format projects/*/locations/*/registrations/*.

dnsSettings DnsSettings

Fields of the DnsSettings to update.

updateMask FieldMask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the name servers are being updated for an existing Custom DNS configuration, the update_mask is "custom_dns.name_servers".

When changing the DNS provider from one type to another, pass the new provider's field name as part of the field mask. For example, when changing from a Google Domains DNS configuration to a Custom DNS configuration, the update_mask is "custom_dns". //

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
string registration = "projects/[PROJECT]/locations/[LOCATION]/registrations/[REGISTRATION]";
DnsSettings dnsSettings = new DnsSettings();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Registration, OperationMetadata> response = domainsClient.ConfigureDnsSettings(registration, dnsSettings, updateMask);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = domainsClient.PollOnceConfigureDnsSettings(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureDnsSettingsAsync(ConfigureDnsSettingsRequest, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> ConfigureDnsSettingsAsync(ConfigureDnsSettingsRequest request, CallSettings callSettings = null)

Updates a Registration's DNS settings.

Parameters
Name Description
request ConfigureDnsSettingsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
ConfigureDnsSettingsRequest request = new ConfigureDnsSettingsRequest
{
    RegistrationAsRegistrationName = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]"),
    DnsSettings = new DnsSettings(),
    UpdateMask = new FieldMask(),
    ValidateOnly = false,
};
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.ConfigureDnsSettingsAsync(request);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceConfigureDnsSettingsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureDnsSettingsAsync(ConfigureDnsSettingsRequest, CancellationToken)

public virtual Task<Operation<Registration, OperationMetadata>> ConfigureDnsSettingsAsync(ConfigureDnsSettingsRequest request, CancellationToken cancellationToken)

Updates a Registration's DNS settings.

Parameters
Name Description
request ConfigureDnsSettingsRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
ConfigureDnsSettingsRequest request = new ConfigureDnsSettingsRequest
{
    RegistrationAsRegistrationName = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]"),
    DnsSettings = new DnsSettings(),
    UpdateMask = new FieldMask(),
    ValidateOnly = false,
};
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.ConfigureDnsSettingsAsync(request);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceConfigureDnsSettingsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureDnsSettingsAsync(RegistrationName, DnsSettings, FieldMask, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> ConfigureDnsSettingsAsync(RegistrationName registration, DnsSettings dnsSettings, FieldMask updateMask, CallSettings callSettings = null)

Updates a Registration's DNS settings.

Parameters
Name Description
registration RegistrationName

Required. The name of the Registration whose DNS settings are being updated, in the format projects/*/locations/*/registrations/*.

dnsSettings DnsSettings

Fields of the DnsSettings to update.

updateMask FieldMask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the name servers are being updated for an existing Custom DNS configuration, the update_mask is "custom_dns.name_servers".

When changing the DNS provider from one type to another, pass the new provider's field name as part of the field mask. For example, when changing from a Google Domains DNS configuration to a Custom DNS configuration, the update_mask is "custom_dns". //

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
RegistrationName registration = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
DnsSettings dnsSettings = new DnsSettings();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.ConfigureDnsSettingsAsync(registration, dnsSettings, updateMask);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceConfigureDnsSettingsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureDnsSettingsAsync(RegistrationName, DnsSettings, FieldMask, CancellationToken)

public virtual Task<Operation<Registration, OperationMetadata>> ConfigureDnsSettingsAsync(RegistrationName registration, DnsSettings dnsSettings, FieldMask updateMask, CancellationToken cancellationToken)

Updates a Registration's DNS settings.

Parameters
Name Description
registration RegistrationName

Required. The name of the Registration whose DNS settings are being updated, in the format projects/*/locations/*/registrations/*.

dnsSettings DnsSettings

Fields of the DnsSettings to update.

updateMask FieldMask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the name servers are being updated for an existing Custom DNS configuration, the update_mask is "custom_dns.name_servers".

When changing the DNS provider from one type to another, pass the new provider's field name as part of the field mask. For example, when changing from a Google Domains DNS configuration to a Custom DNS configuration, the update_mask is "custom_dns". //

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
RegistrationName registration = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
DnsSettings dnsSettings = new DnsSettings();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.ConfigureDnsSettingsAsync(registration, dnsSettings, updateMask);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceConfigureDnsSettingsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureDnsSettingsAsync(string, DnsSettings, FieldMask, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> ConfigureDnsSettingsAsync(string registration, DnsSettings dnsSettings, FieldMask updateMask, CallSettings callSettings = null)

Updates a Registration's DNS settings.

Parameters
Name Description
registration string

Required. The name of the Registration whose DNS settings are being updated, in the format projects/*/locations/*/registrations/*.

dnsSettings DnsSettings

Fields of the DnsSettings to update.

updateMask FieldMask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the name servers are being updated for an existing Custom DNS configuration, the update_mask is "custom_dns.name_servers".

When changing the DNS provider from one type to another, pass the new provider's field name as part of the field mask. For example, when changing from a Google Domains DNS configuration to a Custom DNS configuration, the update_mask is "custom_dns". //

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string registration = "projects/[PROJECT]/locations/[LOCATION]/registrations/[REGISTRATION]";
DnsSettings dnsSettings = new DnsSettings();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.ConfigureDnsSettingsAsync(registration, dnsSettings, updateMask);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceConfigureDnsSettingsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureDnsSettingsAsync(string, DnsSettings, FieldMask, CancellationToken)

public virtual Task<Operation<Registration, OperationMetadata>> ConfigureDnsSettingsAsync(string registration, DnsSettings dnsSettings, FieldMask updateMask, CancellationToken cancellationToken)

Updates a Registration's DNS settings.

Parameters
Name Description
registration string

Required. The name of the Registration whose DNS settings are being updated, in the format projects/*/locations/*/registrations/*.

dnsSettings DnsSettings

Fields of the DnsSettings to update.

updateMask FieldMask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the name servers are being updated for an existing Custom DNS configuration, the update_mask is "custom_dns.name_servers".

When changing the DNS provider from one type to another, pass the new provider's field name as part of the field mask. For example, when changing from a Google Domains DNS configuration to a Custom DNS configuration, the update_mask is "custom_dns". //

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string registration = "projects/[PROJECT]/locations/[LOCATION]/registrations/[REGISTRATION]";
DnsSettings dnsSettings = new DnsSettings();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.ConfigureDnsSettingsAsync(registration, dnsSettings, updateMask);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceConfigureDnsSettingsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureManagementSettings(ConfigureManagementSettingsRequest, CallSettings)

public virtual Operation<Registration, OperationMetadata> ConfigureManagementSettings(ConfigureManagementSettingsRequest request, CallSettings callSettings = null)

Updates a Registration's management settings.

Parameters
Name Description
request ConfigureManagementSettingsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
ConfigureManagementSettingsRequest request = new ConfigureManagementSettingsRequest
{
    RegistrationAsRegistrationName = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]"),
    ManagementSettings = new ManagementSettings(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<Registration, OperationMetadata> response = domainsClient.ConfigureManagementSettings(request);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = domainsClient.PollOnceConfigureManagementSettings(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureManagementSettings(RegistrationName, ManagementSettings, FieldMask, CallSettings)

public virtual Operation<Registration, OperationMetadata> ConfigureManagementSettings(RegistrationName registration, ManagementSettings managementSettings, FieldMask updateMask, CallSettings callSettings = null)

Updates a Registration's management settings.

Parameters
Name Description
registration RegistrationName

Required. The name of the Registration whose management settings are being updated, in the format projects/*/locations/*/registrations/*.

managementSettings ManagementSettings

Fields of the ManagementSettings to update.

updateMask FieldMask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the transfer lock is being updated, the update_mask is "transfer_lock_state".

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
RegistrationName registration = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
ManagementSettings managementSettings = new ManagementSettings();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Registration, OperationMetadata> response = domainsClient.ConfigureManagementSettings(registration, managementSettings, updateMask);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = domainsClient.PollOnceConfigureManagementSettings(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureManagementSettings(string, ManagementSettings, FieldMask, CallSettings)

public virtual Operation<Registration, OperationMetadata> ConfigureManagementSettings(string registration, ManagementSettings managementSettings, FieldMask updateMask, CallSettings callSettings = null)

Updates a Registration's management settings.

Parameters
Name Description
registration string

Required. The name of the Registration whose management settings are being updated, in the format projects/*/locations/*/registrations/*.

managementSettings ManagementSettings

Fields of the ManagementSettings to update.

updateMask FieldMask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the transfer lock is being updated, the update_mask is "transfer_lock_state".

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
string registration = "projects/[PROJECT]/locations/[LOCATION]/registrations/[REGISTRATION]";
ManagementSettings managementSettings = new ManagementSettings();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Registration, OperationMetadata> response = domainsClient.ConfigureManagementSettings(registration, managementSettings, updateMask);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = domainsClient.PollOnceConfigureManagementSettings(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureManagementSettingsAsync(ConfigureManagementSettingsRequest, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> ConfigureManagementSettingsAsync(ConfigureManagementSettingsRequest request, CallSettings callSettings = null)

Updates a Registration's management settings.

Parameters
Name Description
request ConfigureManagementSettingsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
ConfigureManagementSettingsRequest request = new ConfigureManagementSettingsRequest
{
    RegistrationAsRegistrationName = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]"),
    ManagementSettings = new ManagementSettings(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.ConfigureManagementSettingsAsync(request);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceConfigureManagementSettingsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureManagementSettingsAsync(ConfigureManagementSettingsRequest, CancellationToken)

public virtual Task<Operation<Registration, OperationMetadata>> ConfigureManagementSettingsAsync(ConfigureManagementSettingsRequest request, CancellationToken cancellationToken)

Updates a Registration's management settings.

Parameters
Name Description
request ConfigureManagementSettingsRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
ConfigureManagementSettingsRequest request = new ConfigureManagementSettingsRequest
{
    RegistrationAsRegistrationName = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]"),
    ManagementSettings = new ManagementSettings(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.ConfigureManagementSettingsAsync(request);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceConfigureManagementSettingsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureManagementSettingsAsync(RegistrationName, ManagementSettings, FieldMask, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> ConfigureManagementSettingsAsync(RegistrationName registration, ManagementSettings managementSettings, FieldMask updateMask, CallSettings callSettings = null)

Updates a Registration's management settings.

Parameters
Name Description
registration RegistrationName

Required. The name of the Registration whose management settings are being updated, in the format projects/*/locations/*/registrations/*.

managementSettings ManagementSettings

Fields of the ManagementSettings to update.

updateMask FieldMask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the transfer lock is being updated, the update_mask is "transfer_lock_state".

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
RegistrationName registration = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
ManagementSettings managementSettings = new ManagementSettings();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.ConfigureManagementSettingsAsync(registration, managementSettings, updateMask);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceConfigureManagementSettingsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureManagementSettingsAsync(RegistrationName, ManagementSettings, FieldMask, CancellationToken)

public virtual Task<Operation<Registration, OperationMetadata>> ConfigureManagementSettingsAsync(RegistrationName registration, ManagementSettings managementSettings, FieldMask updateMask, CancellationToken cancellationToken)

Updates a Registration's management settings.

Parameters
Name Description
registration RegistrationName

Required. The name of the Registration whose management settings are being updated, in the format projects/*/locations/*/registrations/*.

managementSettings ManagementSettings

Fields of the ManagementSettings to update.

updateMask FieldMask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the transfer lock is being updated, the update_mask is "transfer_lock_state".

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
RegistrationName registration = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
ManagementSettings managementSettings = new ManagementSettings();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.ConfigureManagementSettingsAsync(registration, managementSettings, updateMask);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceConfigureManagementSettingsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureManagementSettingsAsync(string, ManagementSettings, FieldMask, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> ConfigureManagementSettingsAsync(string registration, ManagementSettings managementSettings, FieldMask updateMask, CallSettings callSettings = null)

Updates a Registration's management settings.

Parameters
Name Description
registration string

Required. The name of the Registration whose management settings are being updated, in the format projects/*/locations/*/registrations/*.

managementSettings ManagementSettings

Fields of the ManagementSettings to update.

updateMask FieldMask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the transfer lock is being updated, the update_mask is "transfer_lock_state".

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string registration = "projects/[PROJECT]/locations/[LOCATION]/registrations/[REGISTRATION]";
ManagementSettings managementSettings = new ManagementSettings();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.ConfigureManagementSettingsAsync(registration, managementSettings, updateMask);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceConfigureManagementSettingsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ConfigureManagementSettingsAsync(string, ManagementSettings, FieldMask, CancellationToken)

public virtual Task<Operation<Registration, OperationMetadata>> ConfigureManagementSettingsAsync(string registration, ManagementSettings managementSettings, FieldMask updateMask, CancellationToken cancellationToken)

Updates a Registration's management settings.

Parameters
Name Description
registration string

Required. The name of the Registration whose management settings are being updated, in the format projects/*/locations/*/registrations/*.

managementSettings ManagementSettings

Fields of the ManagementSettings to update.

updateMask FieldMask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the transfer lock is being updated, the update_mask is "transfer_lock_state".

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string registration = "projects/[PROJECT]/locations/[LOCATION]/registrations/[REGISTRATION]";
ManagementSettings managementSettings = new ManagementSettings();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.ConfigureManagementSettingsAsync(registration, managementSettings, updateMask);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceConfigureManagementSettingsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

Create()

public static DomainsClient Create()

Synchronously creates a DomainsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use DomainsClientBuilder.

Returns
Type Description
DomainsClient

The created DomainsClient.

CreateAsync(CancellationToken)

public static Task<DomainsClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a DomainsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use DomainsClientBuilder.

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskDomainsClient

The task representing the created DomainsClient.

DeleteRegistration(DeleteRegistrationRequest, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteRegistration(DeleteRegistrationRequest request, CallSettings callSettings = null)

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.

For Registration resources using Monthly billing, this method works if:

  • state is EXPORTED with expire_time in the past
  • state is REGISTRATION_FAILED
  • state is TRANSFER_FAILED

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.

Parameters
Name Description
request DeleteRegistrationRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
DeleteRegistrationRequest request = new DeleteRegistrationRequest
{
    RegistrationName = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = domainsClient.DeleteRegistration(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = domainsClient.PollOnceDeleteRegistration(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteRegistration(RegistrationName, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteRegistration(RegistrationName name, CallSettings callSettings = null)

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.

For Registration resources using Monthly billing, this method works if:

  • state is EXPORTED with expire_time in the past
  • state is REGISTRATION_FAILED
  • state is TRANSFER_FAILED

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.

Parameters
Name Description
name RegistrationName

Required. The name of the Registration to delete, in the format projects/*/locations/*/registrations/*.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
RegistrationName name = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
// Make the request
Operation<Empty, OperationMetadata> response = domainsClient.DeleteRegistration(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = domainsClient.PollOnceDeleteRegistration(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteRegistration(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteRegistration(string name, CallSettings callSettings = null)

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.

For Registration resources using Monthly billing, this method works if:

  • state is EXPORTED with expire_time in the past
  • state is REGISTRATION_FAILED
  • state is TRANSFER_FAILED

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.

Parameters
Name Description
name string

Required. The name of the Registration to delete, in the format projects/*/locations/*/registrations/*.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/registrations/[REGISTRATION]";
// Make the request
Operation<Empty, OperationMetadata> response = domainsClient.DeleteRegistration(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = domainsClient.PollOnceDeleteRegistration(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteRegistrationAsync(DeleteRegistrationRequest, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteRegistrationAsync(DeleteRegistrationRequest request, CallSettings callSettings = null)

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.

For Registration resources using Monthly billing, this method works if:

  • state is EXPORTED with expire_time in the past
  • state is REGISTRATION_FAILED
  • state is TRANSFER_FAILED

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.

Parameters
Name Description
request DeleteRegistrationRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
DeleteRegistrationRequest request = new DeleteRegistrationRequest
{
    RegistrationName = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = await domainsClient.DeleteRegistrationAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await domainsClient.PollOnceDeleteRegistrationAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteRegistrationAsync(DeleteRegistrationRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteRegistrationAsync(DeleteRegistrationRequest request, CancellationToken cancellationToken)

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.

For Registration resources using Monthly billing, this method works if:

  • state is EXPORTED with expire_time in the past
  • state is REGISTRATION_FAILED
  • state is TRANSFER_FAILED

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.

Parameters
Name Description
request DeleteRegistrationRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
DeleteRegistrationRequest request = new DeleteRegistrationRequest
{
    RegistrationName = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = await domainsClient.DeleteRegistrationAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await domainsClient.PollOnceDeleteRegistrationAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteRegistrationAsync(RegistrationName, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteRegistrationAsync(RegistrationName name, CallSettings callSettings = null)

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.

For Registration resources using Monthly billing, this method works if:

  • state is EXPORTED with expire_time in the past
  • state is REGISTRATION_FAILED
  • state is TRANSFER_FAILED

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.

Parameters
Name Description
name RegistrationName

Required. The name of the Registration to delete, in the format projects/*/locations/*/registrations/*.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
RegistrationName name = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
// Make the request
Operation<Empty, OperationMetadata> response = await domainsClient.DeleteRegistrationAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await domainsClient.PollOnceDeleteRegistrationAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteRegistrationAsync(RegistrationName, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteRegistrationAsync(RegistrationName name, CancellationToken cancellationToken)

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.

For Registration resources using Monthly billing, this method works if:

  • state is EXPORTED with expire_time in the past
  • state is REGISTRATION_FAILED
  • state is TRANSFER_FAILED

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.

Parameters
Name Description
name RegistrationName

Required. The name of the Registration to delete, in the format projects/*/locations/*/registrations/*.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
RegistrationName name = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
// Make the request
Operation<Empty, OperationMetadata> response = await domainsClient.DeleteRegistrationAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await domainsClient.PollOnceDeleteRegistrationAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteRegistrationAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteRegistrationAsync(string name, CallSettings callSettings = null)

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.

For Registration resources using Monthly billing, this method works if:

  • state is EXPORTED with expire_time in the past
  • state is REGISTRATION_FAILED
  • state is TRANSFER_FAILED

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.

Parameters
Name Description
name string

Required. The name of the Registration to delete, in the format projects/*/locations/*/registrations/*.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/registrations/[REGISTRATION]";
// Make the request
Operation<Empty, OperationMetadata> response = await domainsClient.DeleteRegistrationAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await domainsClient.PollOnceDeleteRegistrationAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteRegistrationAsync(string, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteRegistrationAsync(string name, CancellationToken cancellationToken)

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.

For Registration resources using Monthly billing, this method works if:

  • state is EXPORTED with expire_time in the past
  • state is REGISTRATION_FAILED
  • state is TRANSFER_FAILED

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.

Parameters
Name Description
name string

Required. The name of the Registration to delete, in the format projects/*/locations/*/registrations/*.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/registrations/[REGISTRATION]";
// Make the request
Operation<Empty, OperationMetadata> response = await domainsClient.DeleteRegistrationAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await domainsClient.PollOnceDeleteRegistrationAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

ExportRegistration(ExportRegistrationRequest, CallSettings)

public virtual Operation<Registration, OperationMetadata> ExportRegistration(ExportRegistrationRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request ExportRegistrationRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
ExportRegistrationRequest request = new ExportRegistrationRequest
{
    RegistrationName = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]"),
};
// Make the request
Operation<Registration, OperationMetadata> response = domainsClient.ExportRegistration(request);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = domainsClient.PollOnceExportRegistration(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ExportRegistration(RegistrationName, CallSettings)

public virtual Operation<Registration, OperationMetadata> ExportRegistration(RegistrationName name, CallSettings callSettings = null)

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.

Parameters
Name Description
name RegistrationName

Required. The name of the Registration to export, in the format projects/*/locations/*/registrations/*.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
RegistrationName name = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
// Make the request
Operation<Registration, OperationMetadata> response = domainsClient.ExportRegistration(name);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = domainsClient.PollOnceExportRegistration(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ExportRegistration(string, CallSettings)

public virtual Operation<Registration, OperationMetadata> ExportRegistration(string name, CallSettings callSettings = null)

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.

Parameters
Name Description
name string

Required. The name of the Registration to export, in the format projects/*/locations/*/registrations/*.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/registrations/[REGISTRATION]";
// Make the request
Operation<Registration, OperationMetadata> response = domainsClient.ExportRegistration(name);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = domainsClient.PollOnceExportRegistration(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ExportRegistrationAsync(ExportRegistrationRequest, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> ExportRegistrationAsync(ExportRegistrationRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request ExportRegistrationRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
ExportRegistrationRequest request = new ExportRegistrationRequest
{
    RegistrationName = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]"),
};
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.ExportRegistrationAsync(request);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceExportRegistrationAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ExportRegistrationAsync(ExportRegistrationRequest, CancellationToken)

public virtual Task<Operation<Registration, OperationMetadata>> ExportRegistrationAsync(ExportRegistrationRequest request, CancellationToken cancellationToken)

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.

Parameters
Name Description
request ExportRegistrationRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
ExportRegistrationRequest request = new ExportRegistrationRequest
{
    RegistrationName = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]"),
};
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.ExportRegistrationAsync(request);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceExportRegistrationAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ExportRegistrationAsync(RegistrationName, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> ExportRegistrationAsync(RegistrationName name, CallSettings callSettings = null)

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.

Parameters
Name Description
name RegistrationName

Required. The name of the Registration to export, in the format projects/*/locations/*/registrations/*.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
RegistrationName name = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.ExportRegistrationAsync(name);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceExportRegistrationAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ExportRegistrationAsync(RegistrationName, CancellationToken)

public virtual Task<Operation<Registration, OperationMetadata>> ExportRegistrationAsync(RegistrationName name, CancellationToken cancellationToken)

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.

Parameters
Name Description
name RegistrationName

Required. The name of the Registration to export, in the format projects/*/locations/*/registrations/*.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
RegistrationName name = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.ExportRegistrationAsync(name);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceExportRegistrationAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ExportRegistrationAsync(string, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> ExportRegistrationAsync(string name, CallSettings callSettings = null)

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.

Parameters
Name Description
name string

Required. The name of the Registration to export, in the format projects/*/locations/*/registrations/*.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/registrations/[REGISTRATION]";
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.ExportRegistrationAsync(name);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceExportRegistrationAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ExportRegistrationAsync(string, CancellationToken)

public virtual Task<Operation<Registration, OperationMetadata>> ExportRegistrationAsync(string name, CancellationToken cancellationToken)

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.

Parameters
Name Description
name string

Required. The name of the Registration to export, in the format projects/*/locations/*/registrations/*.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/registrations/[REGISTRATION]";
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.ExportRegistrationAsync(name);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceExportRegistrationAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

GetRegistration(GetRegistrationRequest, CallSettings)

public virtual Registration GetRegistration(GetRegistrationRequest request, CallSettings callSettings = null)

Gets the details of a Registration resource.

Parameters
Name Description
request GetRegistrationRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Registration

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
GetRegistrationRequest request = new GetRegistrationRequest
{
    RegistrationName = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]"),
};
// Make the request
Registration response = domainsClient.GetRegistration(request);

GetRegistration(RegistrationName, CallSettings)

public virtual Registration GetRegistration(RegistrationName name, CallSettings callSettings = null)

Gets the details of a Registration resource.

Parameters
Name Description
name RegistrationName

Required. The name of the Registration to get, in the format projects/*/locations/*/registrations/*.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Registration

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
RegistrationName name = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
// Make the request
Registration response = domainsClient.GetRegistration(name);

GetRegistration(string, CallSettings)

public virtual Registration GetRegistration(string name, CallSettings callSettings = null)

Gets the details of a Registration resource.

Parameters
Name Description
name string

Required. The name of the Registration to get, in the format projects/*/locations/*/registrations/*.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Registration

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/registrations/[REGISTRATION]";
// Make the request
Registration response = domainsClient.GetRegistration(name);

GetRegistrationAsync(GetRegistrationRequest, CallSettings)

public virtual Task<Registration> GetRegistrationAsync(GetRegistrationRequest request, CallSettings callSettings = null)

Gets the details of a Registration resource.

Parameters
Name Description
request GetRegistrationRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskRegistration

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
GetRegistrationRequest request = new GetRegistrationRequest
{
    RegistrationName = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]"),
};
// Make the request
Registration response = await domainsClient.GetRegistrationAsync(request);

GetRegistrationAsync(GetRegistrationRequest, CancellationToken)

public virtual Task<Registration> GetRegistrationAsync(GetRegistrationRequest request, CancellationToken cancellationToken)

Gets the details of a Registration resource.

Parameters
Name Description
request GetRegistrationRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRegistration

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
GetRegistrationRequest request = new GetRegistrationRequest
{
    RegistrationName = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]"),
};
// Make the request
Registration response = await domainsClient.GetRegistrationAsync(request);

GetRegistrationAsync(RegistrationName, CallSettings)

public virtual Task<Registration> GetRegistrationAsync(RegistrationName name, CallSettings callSettings = null)

Gets the details of a Registration resource.

Parameters
Name Description
name RegistrationName

Required. The name of the Registration to get, in the format projects/*/locations/*/registrations/*.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskRegistration

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
RegistrationName name = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
// Make the request
Registration response = await domainsClient.GetRegistrationAsync(name);

GetRegistrationAsync(RegistrationName, CancellationToken)

public virtual Task<Registration> GetRegistrationAsync(RegistrationName name, CancellationToken cancellationToken)

Gets the details of a Registration resource.

Parameters
Name Description
name RegistrationName

Required. The name of the Registration to get, in the format projects/*/locations/*/registrations/*.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRegistration

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
RegistrationName name = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
// Make the request
Registration response = await domainsClient.GetRegistrationAsync(name);

GetRegistrationAsync(string, CallSettings)

public virtual Task<Registration> GetRegistrationAsync(string name, CallSettings callSettings = null)

Gets the details of a Registration resource.

Parameters
Name Description
name string

Required. The name of the Registration to get, in the format projects/*/locations/*/registrations/*.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskRegistration

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/registrations/[REGISTRATION]";
// Make the request
Registration response = await domainsClient.GetRegistrationAsync(name);

GetRegistrationAsync(string, CancellationToken)

public virtual Task<Registration> GetRegistrationAsync(string name, CancellationToken cancellationToken)

Gets the details of a Registration resource.

Parameters
Name Description
name string

Required. The name of the Registration to get, in the format projects/*/locations/*/registrations/*.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRegistration

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/registrations/[REGISTRATION]";
// Make the request
Registration response = await domainsClient.GetRegistrationAsync(name);

ListRegistrations(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListRegistrationsResponse, Registration> ListRegistrations(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the Registration resources in a project.

Parameters
Name Description
parent LocationName

Required. The project and location from which to list Registrations, specified in the format projects/*/locations/*.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListRegistrationsResponseRegistration

A pageable sequence of Registration resources.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListRegistrationsResponse, Registration> response = domainsClient.ListRegistrations(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Registration item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListRegistrationsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Registration item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Registration> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Registration item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRegistrations(ListRegistrationsRequest, CallSettings)

public virtual PagedEnumerable<ListRegistrationsResponse, Registration> ListRegistrations(ListRegistrationsRequest request, CallSettings callSettings = null)

Lists the Registration resources in a project.

Parameters
Name Description
request ListRegistrationsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListRegistrationsResponseRegistration

A pageable sequence of Registration resources.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
ListRegistrationsRequest request = new ListRegistrationsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListRegistrationsResponse, Registration> response = domainsClient.ListRegistrations(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Registration item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListRegistrationsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Registration item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Registration> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Registration item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRegistrations(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListRegistrationsResponse, Registration> ListRegistrations(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the Registration resources in a project.

Parameters
Name Description
parent string

Required. The project and location from which to list Registrations, specified in the format projects/*/locations/*.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListRegistrationsResponseRegistration

A pageable sequence of Registration resources.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListRegistrationsResponse, Registration> response = domainsClient.ListRegistrations(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Registration item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListRegistrationsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Registration item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Registration> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Registration item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRegistrationsAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListRegistrationsResponse, Registration> ListRegistrationsAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the Registration resources in a project.

Parameters
Name Description
parent LocationName

Required. The project and location from which to list Registrations, specified in the format projects/*/locations/*.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListRegistrationsResponseRegistration

A pageable asynchronous sequence of Registration resources.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListRegistrationsResponse, Registration> response = domainsClient.ListRegistrationsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Registration item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListRegistrationsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Registration item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Registration> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Registration item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRegistrationsAsync(ListRegistrationsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListRegistrationsResponse, Registration> ListRegistrationsAsync(ListRegistrationsRequest request, CallSettings callSettings = null)

Lists the Registration resources in a project.

Parameters
Name Description
request ListRegistrationsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListRegistrationsResponseRegistration

A pageable asynchronous sequence of Registration resources.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
ListRegistrationsRequest request = new ListRegistrationsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListRegistrationsResponse, Registration> response = domainsClient.ListRegistrationsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Registration item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListRegistrationsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Registration item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Registration> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Registration item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRegistrationsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListRegistrationsResponse, Registration> ListRegistrationsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the Registration resources in a project.

Parameters
Name Description
parent string

Required. The project and location from which to list Registrations, specified in the format projects/*/locations/*.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListRegistrationsResponseRegistration

A pageable asynchronous sequence of Registration resources.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListRegistrationsResponse, Registration> response = domainsClient.ListRegistrationsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Registration item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListRegistrationsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Registration item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Registration> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Registration item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PollOnceConfigureContactSettings(string, CallSettings)

public virtual Operation<Registration, OperationMetadata> PollOnceConfigureContactSettings(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of ConfigureContactSettings.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The result of polling the operation.

PollOnceConfigureContactSettingsAsync(string, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> PollOnceConfigureContactSettingsAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of ConfigureContactSettings.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A task representing the result of polling the operation.

PollOnceConfigureDnsSettings(string, CallSettings)

public virtual Operation<Registration, OperationMetadata> PollOnceConfigureDnsSettings(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of ConfigureDnsSettings .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The result of polling the operation.

PollOnceConfigureDnsSettingsAsync(string, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> PollOnceConfigureDnsSettingsAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of ConfigureDnsSettings.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A task representing the result of polling the operation.

PollOnceConfigureManagementSettings(string, CallSettings)

public virtual Operation<Registration, OperationMetadata> PollOnceConfigureManagementSettings(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of ConfigureManagementSettings.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The result of polling the operation.

PollOnceConfigureManagementSettingsAsync(string, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> PollOnceConfigureManagementSettingsAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of ConfigureManagementSettings.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteRegistration(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> PollOnceDeleteRegistration(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteRegistration .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The result of polling the operation.

PollOnceDeleteRegistrationAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> PollOnceDeleteRegistrationAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteRegistration.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A task representing the result of polling the operation.

PollOnceExportRegistration(string, CallSettings)

public virtual Operation<Registration, OperationMetadata> PollOnceExportRegistration(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of ExportRegistration .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The result of polling the operation.

PollOnceExportRegistrationAsync(string, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> PollOnceExportRegistrationAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of ExportRegistration.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A task representing the result of polling the operation.

PollOnceRegisterDomain(string, CallSettings)

public virtual Operation<Registration, OperationMetadata> PollOnceRegisterDomain(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of RegisterDomain.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The result of polling the operation.

PollOnceRegisterDomainAsync(string, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> PollOnceRegisterDomainAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of RegisterDomain.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A task representing the result of polling the operation.

PollOnceTransferDomain(string, CallSettings)

public virtual Operation<Registration, OperationMetadata> PollOnceTransferDomain(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of TransferDomain.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The result of polling the operation.

PollOnceTransferDomainAsync(string, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> PollOnceTransferDomainAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of TransferDomain.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A task representing the result of polling the operation.

PollOnceUpdateRegistration(string, CallSettings)

public virtual Operation<Registration, OperationMetadata> PollOnceUpdateRegistration(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of UpdateRegistration .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The result of polling the operation.

PollOnceUpdateRegistrationAsync(string, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> PollOnceUpdateRegistrationAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of UpdateRegistration.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A task representing the result of polling the operation.

RegisterDomain(LocationName, Registration, Money, CallSettings)

public virtual Operation<Registration, OperationMetadata> RegisterDomain(LocationName parent, Registration registration, Money yearlyPrice, CallSettings callSettings = null)

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
Name Description
parent LocationName

Required. The parent resource of the Registration. Must be in the format projects/*/locations/*.

registration Registration

Required. The complete Registration resource to be created.

yearlyPrice Money

Required. Yearly price to register or renew the domain. The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Registration registration = new Registration();
Money yearlyPrice = new Money();
// Make the request
Operation<Registration, OperationMetadata> response = domainsClient.RegisterDomain(parent, registration, yearlyPrice);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = domainsClient.PollOnceRegisterDomain(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

RegisterDomain(RegisterDomainRequest, CallSettings)

public virtual Operation<Registration, OperationMetadata> RegisterDomain(RegisterDomainRequest request, CallSettings callSettings = null)

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
Name Description
request RegisterDomainRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
RegisterDomainRequest request = new RegisterDomainRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Registration = new Registration(),
    DomainNotices =
    {
        DomainNotice.Unspecified,
    },
    ContactNotices =
    {
        ContactNotice.Unspecified,
    },
    YearlyPrice = new Money(),
    ValidateOnly = false,
};
// Make the request
Operation<Registration, OperationMetadata> response = domainsClient.RegisterDomain(request);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = domainsClient.PollOnceRegisterDomain(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

RegisterDomain(string, Registration, Money, CallSettings)

public virtual Operation<Registration, OperationMetadata> RegisterDomain(string parent, Registration registration, Money yearlyPrice, CallSettings callSettings = null)

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
Name Description
parent string

Required. The parent resource of the Registration. Must be in the format projects/*/locations/*.

registration Registration

Required. The complete Registration resource to be created.

yearlyPrice Money

Required. Yearly price to register or renew the domain. The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Registration registration = new Registration();
Money yearlyPrice = new Money();
// Make the request
Operation<Registration, OperationMetadata> response = domainsClient.RegisterDomain(parent, registration, yearlyPrice);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = domainsClient.PollOnceRegisterDomain(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

RegisterDomainAsync(LocationName, Registration, Money, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> RegisterDomainAsync(LocationName parent, Registration registration, Money yearlyPrice, CallSettings callSettings = null)

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
Name Description
parent LocationName

Required. The parent resource of the Registration. Must be in the format projects/*/locations/*.

registration Registration

Required. The complete Registration resource to be created.

yearlyPrice Money

Required. Yearly price to register or renew the domain. The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Registration registration = new Registration();
Money yearlyPrice = new Money();
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.RegisterDomainAsync(parent, registration, yearlyPrice);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceRegisterDomainAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

RegisterDomainAsync(LocationName, Registration, Money, CancellationToken)

public virtual Task<Operation<Registration, OperationMetadata>> RegisterDomainAsync(LocationName parent, Registration registration, Money yearlyPrice, CancellationToken cancellationToken)

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
Name Description
parent LocationName

Required. The parent resource of the Registration. Must be in the format projects/*/locations/*.

registration Registration

Required. The complete Registration resource to be created.

yearlyPrice Money

Required. Yearly price to register or renew the domain. The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Registration registration = new Registration();
Money yearlyPrice = new Money();
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.RegisterDomainAsync(parent, registration, yearlyPrice);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceRegisterDomainAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

RegisterDomainAsync(RegisterDomainRequest, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> RegisterDomainAsync(RegisterDomainRequest request, CallSettings callSettings = null)

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
Name Description
request RegisterDomainRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
RegisterDomainRequest request = new RegisterDomainRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Registration = new Registration(),
    DomainNotices =
    {
        DomainNotice.Unspecified,
    },
    ContactNotices =
    {
        ContactNotice.Unspecified,
    },
    YearlyPrice = new Money(),
    ValidateOnly = false,
};
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.RegisterDomainAsync(request);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceRegisterDomainAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

RegisterDomainAsync(RegisterDomainRequest, CancellationToken)

public virtual Task<Operation<Registration, OperationMetadata>> RegisterDomainAsync(RegisterDomainRequest request, CancellationToken cancellationToken)

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
Name Description
request RegisterDomainRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
RegisterDomainRequest request = new RegisterDomainRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Registration = new Registration(),
    DomainNotices =
    {
        DomainNotice.Unspecified,
    },
    ContactNotices =
    {
        ContactNotice.Unspecified,
    },
    YearlyPrice = new Money(),
    ValidateOnly = false,
};
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.RegisterDomainAsync(request);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceRegisterDomainAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

RegisterDomainAsync(string, Registration, Money, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> RegisterDomainAsync(string parent, Registration registration, Money yearlyPrice, CallSettings callSettings = null)

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
Name Description
parent string

Required. The parent resource of the Registration. Must be in the format projects/*/locations/*.

registration Registration

Required. The complete Registration resource to be created.

yearlyPrice Money

Required. Yearly price to register or renew the domain. The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Registration registration = new Registration();
Money yearlyPrice = new Money();
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.RegisterDomainAsync(parent, registration, yearlyPrice);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceRegisterDomainAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

RegisterDomainAsync(string, Registration, Money, CancellationToken)

public virtual Task<Operation<Registration, OperationMetadata>> RegisterDomainAsync(string parent, Registration registration, Money yearlyPrice, CancellationToken cancellationToken)

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
Name Description
parent string

Required. The parent resource of the Registration. Must be in the format projects/*/locations/*.

registration Registration

Required. The complete Registration resource to be created.

yearlyPrice Money

Required. Yearly price to register or renew the domain. The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Registration registration = new Registration();
Money yearlyPrice = new Money();
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.RegisterDomainAsync(parent, registration, yearlyPrice);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceRegisterDomainAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

ResetAuthorizationCode(RegistrationName, CallSettings)

public virtual AuthorizationCode ResetAuthorizationCode(RegistrationName registration, CallSettings callSettings = null)

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
Name Description
registration RegistrationName

Required. The name of the Registration whose authorization code is being reset, in the format projects/*/locations/*/registrations/*.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AuthorizationCode

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
RegistrationName registration = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
// Make the request
AuthorizationCode response = domainsClient.ResetAuthorizationCode(registration);

ResetAuthorizationCode(ResetAuthorizationCodeRequest, CallSettings)

public virtual AuthorizationCode ResetAuthorizationCode(ResetAuthorizationCodeRequest request, CallSettings callSettings = null)

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
Name Description
request ResetAuthorizationCodeRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AuthorizationCode

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
ResetAuthorizationCodeRequest request = new ResetAuthorizationCodeRequest
{
    RegistrationAsRegistrationName = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]"),
};
// Make the request
AuthorizationCode response = domainsClient.ResetAuthorizationCode(request);

ResetAuthorizationCode(string, CallSettings)

public virtual AuthorizationCode ResetAuthorizationCode(string registration, CallSettings callSettings = null)

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
Name Description
registration string

Required. The name of the Registration whose authorization code is being reset, in the format projects/*/locations/*/registrations/*.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AuthorizationCode

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
string registration = "projects/[PROJECT]/locations/[LOCATION]/registrations/[REGISTRATION]";
// Make the request
AuthorizationCode response = domainsClient.ResetAuthorizationCode(registration);

ResetAuthorizationCodeAsync(RegistrationName, CallSettings)

public virtual Task<AuthorizationCode> ResetAuthorizationCodeAsync(RegistrationName registration, CallSettings callSettings = null)

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
Name Description
registration RegistrationName

Required. The name of the Registration whose authorization code is being reset, in the format projects/*/locations/*/registrations/*.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAuthorizationCode

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
RegistrationName registration = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
// Make the request
AuthorizationCode response = await domainsClient.ResetAuthorizationCodeAsync(registration);

ResetAuthorizationCodeAsync(RegistrationName, CancellationToken)

public virtual Task<AuthorizationCode> ResetAuthorizationCodeAsync(RegistrationName registration, CancellationToken cancellationToken)

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
Name Description
registration RegistrationName

Required. The name of the Registration whose authorization code is being reset, in the format projects/*/locations/*/registrations/*.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAuthorizationCode

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
RegistrationName registration = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
// Make the request
AuthorizationCode response = await domainsClient.ResetAuthorizationCodeAsync(registration);

ResetAuthorizationCodeAsync(ResetAuthorizationCodeRequest, CallSettings)

public virtual Task<AuthorizationCode> ResetAuthorizationCodeAsync(ResetAuthorizationCodeRequest request, CallSettings callSettings = null)

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
Name Description
request ResetAuthorizationCodeRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAuthorizationCode

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
ResetAuthorizationCodeRequest request = new ResetAuthorizationCodeRequest
{
    RegistrationAsRegistrationName = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]"),
};
// Make the request
AuthorizationCode response = await domainsClient.ResetAuthorizationCodeAsync(request);

ResetAuthorizationCodeAsync(ResetAuthorizationCodeRequest, CancellationToken)

public virtual Task<AuthorizationCode> ResetAuthorizationCodeAsync(ResetAuthorizationCodeRequest request, CancellationToken cancellationToken)

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
Name Description
request ResetAuthorizationCodeRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAuthorizationCode

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
ResetAuthorizationCodeRequest request = new ResetAuthorizationCodeRequest
{
    RegistrationAsRegistrationName = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]"),
};
// Make the request
AuthorizationCode response = await domainsClient.ResetAuthorizationCodeAsync(request);

ResetAuthorizationCodeAsync(string, CallSettings)

public virtual Task<AuthorizationCode> ResetAuthorizationCodeAsync(string registration, CallSettings callSettings = null)

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
Name Description
registration string

Required. The name of the Registration whose authorization code is being reset, in the format projects/*/locations/*/registrations/*.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAuthorizationCode

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string registration = "projects/[PROJECT]/locations/[LOCATION]/registrations/[REGISTRATION]";
// Make the request
AuthorizationCode response = await domainsClient.ResetAuthorizationCodeAsync(registration);

ResetAuthorizationCodeAsync(string, CancellationToken)

public virtual Task<AuthorizationCode> ResetAuthorizationCodeAsync(string registration, CancellationToken cancellationToken)

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
Name Description
registration string

Required. The name of the Registration whose authorization code is being reset, in the format projects/*/locations/*/registrations/*.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAuthorizationCode

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string registration = "projects/[PROJECT]/locations/[LOCATION]/registrations/[REGISTRATION]";
// Make the request
AuthorizationCode response = await domainsClient.ResetAuthorizationCodeAsync(registration);

RetrieveAuthorizationCode(RegistrationName, CallSettings)

public virtual AuthorizationCode RetrieveAuthorizationCode(RegistrationName registration, CallSettings callSettings = null)

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
Name Description
registration RegistrationName

Required. The name of the Registration whose authorization code is being retrieved, in the format projects/*/locations/*/registrations/*.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AuthorizationCode

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
RegistrationName registration = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
// Make the request
AuthorizationCode response = domainsClient.RetrieveAuthorizationCode(registration);

RetrieveAuthorizationCode(RetrieveAuthorizationCodeRequest, CallSettings)

public virtual AuthorizationCode RetrieveAuthorizationCode(RetrieveAuthorizationCodeRequest request, CallSettings callSettings = null)

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
Name Description
request RetrieveAuthorizationCodeRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AuthorizationCode

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
RetrieveAuthorizationCodeRequest request = new RetrieveAuthorizationCodeRequest
{
    RegistrationAsRegistrationName = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]"),
};
// Make the request
AuthorizationCode response = domainsClient.RetrieveAuthorizationCode(request);

RetrieveAuthorizationCode(string, CallSettings)

public virtual AuthorizationCode RetrieveAuthorizationCode(string registration, CallSettings callSettings = null)

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
Name Description
registration string

Required. The name of the Registration whose authorization code is being retrieved, in the format projects/*/locations/*/registrations/*.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AuthorizationCode

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
string registration = "projects/[PROJECT]/locations/[LOCATION]/registrations/[REGISTRATION]";
// Make the request
AuthorizationCode response = domainsClient.RetrieveAuthorizationCode(registration);

RetrieveAuthorizationCodeAsync(RegistrationName, CallSettings)

public virtual Task<AuthorizationCode> RetrieveAuthorizationCodeAsync(RegistrationName registration, CallSettings callSettings = null)

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
Name Description
registration RegistrationName

Required. The name of the Registration whose authorization code is being retrieved, in the format projects/*/locations/*/registrations/*.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAuthorizationCode

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
RegistrationName registration = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
// Make the request
AuthorizationCode response = await domainsClient.RetrieveAuthorizationCodeAsync(registration);

RetrieveAuthorizationCodeAsync(RegistrationName, CancellationToken)

public virtual Task<AuthorizationCode> RetrieveAuthorizationCodeAsync(RegistrationName registration, CancellationToken cancellationToken)

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
Name Description
registration RegistrationName

Required. The name of the Registration whose authorization code is being retrieved, in the format projects/*/locations/*/registrations/*.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAuthorizationCode

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
RegistrationName registration = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
// Make the request
AuthorizationCode response = await domainsClient.RetrieveAuthorizationCodeAsync(registration);

RetrieveAuthorizationCodeAsync(RetrieveAuthorizationCodeRequest, CallSettings)

public virtual Task<AuthorizationCode> RetrieveAuthorizationCodeAsync(RetrieveAuthorizationCodeRequest request, CallSettings callSettings = null)

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
Name Description
request RetrieveAuthorizationCodeRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAuthorizationCode

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
RetrieveAuthorizationCodeRequest request = new RetrieveAuthorizationCodeRequest
{
    RegistrationAsRegistrationName = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]"),
};
// Make the request
AuthorizationCode response = await domainsClient.RetrieveAuthorizationCodeAsync(request);

RetrieveAuthorizationCodeAsync(RetrieveAuthorizationCodeRequest, CancellationToken)

public virtual Task<AuthorizationCode> RetrieveAuthorizationCodeAsync(RetrieveAuthorizationCodeRequest request, CancellationToken cancellationToken)

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
Name Description
request RetrieveAuthorizationCodeRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAuthorizationCode

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
RetrieveAuthorizationCodeRequest request = new RetrieveAuthorizationCodeRequest
{
    RegistrationAsRegistrationName = RegistrationName.FromProjectLocationRegistration("[PROJECT]", "[LOCATION]", "[REGISTRATION]"),
};
// Make the request
AuthorizationCode response = await domainsClient.RetrieveAuthorizationCodeAsync(request);

RetrieveAuthorizationCodeAsync(string, CallSettings)

public virtual Task<AuthorizationCode> RetrieveAuthorizationCodeAsync(string registration, CallSettings callSettings = null)

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
Name Description
registration string

Required. The name of the Registration whose authorization code is being retrieved, in the format projects/*/locations/*/registrations/*.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAuthorizationCode

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string registration = "projects/[PROJECT]/locations/[LOCATION]/registrations/[REGISTRATION]";
// Make the request
AuthorizationCode response = await domainsClient.RetrieveAuthorizationCodeAsync(registration);

RetrieveAuthorizationCodeAsync(string, CancellationToken)

public virtual Task<AuthorizationCode> RetrieveAuthorizationCodeAsync(string registration, CancellationToken cancellationToken)

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
Name Description
registration string

Required. The name of the Registration whose authorization code is being retrieved, in the format projects/*/locations/*/registrations/*.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAuthorizationCode

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string registration = "projects/[PROJECT]/locations/[LOCATION]/registrations/[REGISTRATION]";
// Make the request
AuthorizationCode response = await domainsClient.RetrieveAuthorizationCodeAsync(registration);

RetrieveRegisterParameters(LocationName, string, CallSettings)

public virtual RetrieveRegisterParametersResponse RetrieveRegisterParameters(LocationName location, string domainName, CallSettings callSettings = null)

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

Parameters
Name Description
location LocationName

Required. The location. Must be in the format projects/*/locations/*.

domainName string

Required. The domain name. Unicode domain names must be expressed in Punycode format.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
RetrieveRegisterParametersResponse

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
LocationName location = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string domainName = "";
// Make the request
RetrieveRegisterParametersResponse response = domainsClient.RetrieveRegisterParameters(location, domainName);

RetrieveRegisterParameters(RetrieveRegisterParametersRequest, CallSettings)

public virtual RetrieveRegisterParametersResponse RetrieveRegisterParameters(RetrieveRegisterParametersRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request RetrieveRegisterParametersRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
RetrieveRegisterParametersResponse

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
RetrieveRegisterParametersRequest request = new RetrieveRegisterParametersRequest
{
    DomainName = "",
    LocationAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
RetrieveRegisterParametersResponse response = domainsClient.RetrieveRegisterParameters(request);

RetrieveRegisterParameters(string, string, CallSettings)

public virtual RetrieveRegisterParametersResponse RetrieveRegisterParameters(string location, string domainName, CallSettings callSettings = null)

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

Parameters
Name Description
location string

Required. The location. Must be in the format projects/*/locations/*.

domainName string

Required. The domain name. Unicode domain names must be expressed in Punycode format.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
RetrieveRegisterParametersResponse

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
string location = "projects/[PROJECT]/locations/[LOCATION]";
string domainName = "";
// Make the request
RetrieveRegisterParametersResponse response = domainsClient.RetrieveRegisterParameters(location, domainName);

RetrieveRegisterParametersAsync(LocationName, string, CallSettings)

public virtual Task<RetrieveRegisterParametersResponse> RetrieveRegisterParametersAsync(LocationName location, string domainName, CallSettings callSettings = null)

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

Parameters
Name Description
location LocationName

Required. The location. Must be in the format projects/*/locations/*.

domainName string

Required. The domain name. Unicode domain names must be expressed in Punycode format.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskRetrieveRegisterParametersResponse

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
LocationName location = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string domainName = "";
// Make the request
RetrieveRegisterParametersResponse response = await domainsClient.RetrieveRegisterParametersAsync(location, domainName);

RetrieveRegisterParametersAsync(LocationName, string, CancellationToken)

public virtual Task<RetrieveRegisterParametersResponse> RetrieveRegisterParametersAsync(LocationName location, string domainName, CancellationToken cancellationToken)

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

Parameters
Name Description
location LocationName

Required. The location. Must be in the format projects/*/locations/*.

domainName string

Required. The domain name. Unicode domain names must be expressed in Punycode format.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRetrieveRegisterParametersResponse

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
LocationName location = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string domainName = "";
// Make the request
RetrieveRegisterParametersResponse response = await domainsClient.RetrieveRegisterParametersAsync(location, domainName);

RetrieveRegisterParametersAsync(RetrieveRegisterParametersRequest, CallSettings)

public virtual Task<RetrieveRegisterParametersResponse> RetrieveRegisterParametersAsync(RetrieveRegisterParametersRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request RetrieveRegisterParametersRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskRetrieveRegisterParametersResponse

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
RetrieveRegisterParametersRequest request = new RetrieveRegisterParametersRequest
{
    DomainName = "",
    LocationAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
RetrieveRegisterParametersResponse response = await domainsClient.RetrieveRegisterParametersAsync(request);

RetrieveRegisterParametersAsync(RetrieveRegisterParametersRequest, CancellationToken)

public virtual Task<RetrieveRegisterParametersResponse> RetrieveRegisterParametersAsync(RetrieveRegisterParametersRequest request, CancellationToken cancellationToken)

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

Parameters
Name Description
request RetrieveRegisterParametersRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRetrieveRegisterParametersResponse

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
RetrieveRegisterParametersRequest request = new RetrieveRegisterParametersRequest
{
    DomainName = "",
    LocationAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
RetrieveRegisterParametersResponse response = await domainsClient.RetrieveRegisterParametersAsync(request);

RetrieveRegisterParametersAsync(string, string, CallSettings)

public virtual Task<RetrieveRegisterParametersResponse> RetrieveRegisterParametersAsync(string location, string domainName, CallSettings callSettings = null)

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

Parameters
Name Description
location string

Required. The location. Must be in the format projects/*/locations/*.

domainName string

Required. The domain name. Unicode domain names must be expressed in Punycode format.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskRetrieveRegisterParametersResponse

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string location = "projects/[PROJECT]/locations/[LOCATION]";
string domainName = "";
// Make the request
RetrieveRegisterParametersResponse response = await domainsClient.RetrieveRegisterParametersAsync(location, domainName);

RetrieveRegisterParametersAsync(string, string, CancellationToken)

public virtual Task<RetrieveRegisterParametersResponse> RetrieveRegisterParametersAsync(string location, string domainName, CancellationToken cancellationToken)

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

Parameters
Name Description
location string

Required. The location. Must be in the format projects/*/locations/*.

domainName string

Required. The domain name. Unicode domain names must be expressed in Punycode format.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRetrieveRegisterParametersResponse

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string location = "projects/[PROJECT]/locations/[LOCATION]";
string domainName = "";
// Make the request
RetrieveRegisterParametersResponse response = await domainsClient.RetrieveRegisterParametersAsync(location, domainName);

RetrieveTransferParameters(LocationName, string, CallSettings)

public virtual RetrieveTransferParametersResponse RetrieveTransferParameters(LocationName location, string domainName, CallSettings callSettings = null)

Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.

Use the returned values to call TransferDomain.

Parameters
Name Description
location LocationName

Required. The location. Must be in the format projects/*/locations/*.

domainName string

Required. The domain name. Unicode domain names must be expressed in Punycode format.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
RetrieveTransferParametersResponse

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
LocationName location = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string domainName = "";
// Make the request
RetrieveTransferParametersResponse response = domainsClient.RetrieveTransferParameters(location, domainName);

RetrieveTransferParameters(RetrieveTransferParametersRequest, CallSettings)

public virtual RetrieveTransferParametersResponse RetrieveTransferParameters(RetrieveTransferParametersRequest request, CallSettings callSettings = null)

Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.

Use the returned values to call TransferDomain.

Parameters
Name Description
request RetrieveTransferParametersRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
RetrieveTransferParametersResponse

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
RetrieveTransferParametersRequest request = new RetrieveTransferParametersRequest
{
    DomainName = "",
    LocationAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
RetrieveTransferParametersResponse response = domainsClient.RetrieveTransferParameters(request);

RetrieveTransferParameters(string, string, CallSettings)

public virtual RetrieveTransferParametersResponse RetrieveTransferParameters(string location, string domainName, CallSettings callSettings = null)

Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.

Use the returned values to call TransferDomain.

Parameters
Name Description
location string

Required. The location. Must be in the format projects/*/locations/*.

domainName string

Required. The domain name. Unicode domain names must be expressed in Punycode format.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
RetrieveTransferParametersResponse

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
string location = "projects/[PROJECT]/locations/[LOCATION]";
string domainName = "";
// Make the request
RetrieveTransferParametersResponse response = domainsClient.RetrieveTransferParameters(location, domainName);

RetrieveTransferParametersAsync(LocationName, string, CallSettings)

public virtual Task<RetrieveTransferParametersResponse> RetrieveTransferParametersAsync(LocationName location, string domainName, CallSettings callSettings = null)

Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.

Use the returned values to call TransferDomain.

Parameters
Name Description
location LocationName

Required. The location. Must be in the format projects/*/locations/*.

domainName string

Required. The domain name. Unicode domain names must be expressed in Punycode format.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskRetrieveTransferParametersResponse

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
LocationName location = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string domainName = "";
// Make the request
RetrieveTransferParametersResponse response = await domainsClient.RetrieveTransferParametersAsync(location, domainName);

RetrieveTransferParametersAsync(LocationName, string, CancellationToken)

public virtual Task<RetrieveTransferParametersResponse> RetrieveTransferParametersAsync(LocationName location, string domainName, CancellationToken cancellationToken)

Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.

Use the returned values to call TransferDomain.

Parameters
Name Description
location LocationName

Required. The location. Must be in the format projects/*/locations/*.

domainName string

Required. The domain name. Unicode domain names must be expressed in Punycode format.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRetrieveTransferParametersResponse

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
LocationName location = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string domainName = "";
// Make the request
RetrieveTransferParametersResponse response = await domainsClient.RetrieveTransferParametersAsync(location, domainName);

RetrieveTransferParametersAsync(RetrieveTransferParametersRequest, CallSettings)

public virtual Task<RetrieveTransferParametersResponse> RetrieveTransferParametersAsync(RetrieveTransferParametersRequest request, CallSettings callSettings = null)

Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.

Use the returned values to call TransferDomain.

Parameters
Name Description
request RetrieveTransferParametersRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskRetrieveTransferParametersResponse

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
RetrieveTransferParametersRequest request = new RetrieveTransferParametersRequest
{
    DomainName = "",
    LocationAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
RetrieveTransferParametersResponse response = await domainsClient.RetrieveTransferParametersAsync(request);

RetrieveTransferParametersAsync(RetrieveTransferParametersRequest, CancellationToken)

public virtual Task<RetrieveTransferParametersResponse> RetrieveTransferParametersAsync(RetrieveTransferParametersRequest request, CancellationToken cancellationToken)

Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.

Use the returned values to call TransferDomain.

Parameters
Name Description
request RetrieveTransferParametersRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRetrieveTransferParametersResponse

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
RetrieveTransferParametersRequest request = new RetrieveTransferParametersRequest
{
    DomainName = "",
    LocationAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
RetrieveTransferParametersResponse response = await domainsClient.RetrieveTransferParametersAsync(request);

RetrieveTransferParametersAsync(string, string, CallSettings)

public virtual Task<RetrieveTransferParametersResponse> RetrieveTransferParametersAsync(string location, string domainName, CallSettings callSettings = null)

Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.

Use the returned values to call TransferDomain.

Parameters
Name Description
location string

Required. The location. Must be in the format projects/*/locations/*.

domainName string

Required. The domain name. Unicode domain names must be expressed in Punycode format.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskRetrieveTransferParametersResponse

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string location = "projects/[PROJECT]/locations/[LOCATION]";
string domainName = "";
// Make the request
RetrieveTransferParametersResponse response = await domainsClient.RetrieveTransferParametersAsync(location, domainName);

RetrieveTransferParametersAsync(string, string, CancellationToken)

public virtual Task<RetrieveTransferParametersResponse> RetrieveTransferParametersAsync(string location, string domainName, CancellationToken cancellationToken)

Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.

Use the returned values to call TransferDomain.

Parameters
Name Description
location string

Required. The location. Must be in the format projects/*/locations/*.

domainName string

Required. The domain name. Unicode domain names must be expressed in Punycode format.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRetrieveTransferParametersResponse

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string location = "projects/[PROJECT]/locations/[LOCATION]";
string domainName = "";
// Make the request
RetrieveTransferParametersResponse response = await domainsClient.RetrieveTransferParametersAsync(location, domainName);

SearchDomains(LocationName, string, CallSettings)

public virtual SearchDomainsResponse SearchDomains(LocationName location, string query, CallSettings callSettings = null)

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
Name Description
location LocationName

Required. The location. Must be in the format projects/*/locations/*.

query string

Required. String used to search for available domain names.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
SearchDomainsResponse

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
LocationName location = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string query = "";
// Make the request
SearchDomainsResponse response = domainsClient.SearchDomains(location, query);

SearchDomains(SearchDomainsRequest, CallSettings)

public virtual SearchDomainsResponse SearchDomains(SearchDomainsRequest request, CallSettings callSettings = null)

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
Name Description
request SearchDomainsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
SearchDomainsResponse

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
SearchDomainsRequest request = new SearchDomainsRequest
{
    Query = "",
    LocationAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
SearchDomainsResponse response = domainsClient.SearchDomains(request);

SearchDomains(string, string, CallSettings)

public virtual SearchDomainsResponse SearchDomains(string location, string query, CallSettings callSettings = null)

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
Name Description
location string

Required. The location. Must be in the format projects/*/locations/*.

query string

Required. String used to search for available domain names.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
SearchDomainsResponse

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
string location = "projects/[PROJECT]/locations/[LOCATION]";
string query = "";
// Make the request
SearchDomainsResponse response = domainsClient.SearchDomains(location, query);

SearchDomainsAsync(LocationName, string, CallSettings)

public virtual Task<SearchDomainsResponse> SearchDomainsAsync(LocationName location, string query, CallSettings callSettings = null)

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
Name Description
location LocationName

Required. The location. Must be in the format projects/*/locations/*.

query string

Required. String used to search for available domain names.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskSearchDomainsResponse

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
LocationName location = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string query = "";
// Make the request
SearchDomainsResponse response = await domainsClient.SearchDomainsAsync(location, query);

SearchDomainsAsync(LocationName, string, CancellationToken)

public virtual Task<SearchDomainsResponse> SearchDomainsAsync(LocationName location, string query, CancellationToken cancellationToken)

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
Name Description
location LocationName

Required. The location. Must be in the format projects/*/locations/*.

query string

Required. String used to search for available domain names.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskSearchDomainsResponse

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
LocationName location = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string query = "";
// Make the request
SearchDomainsResponse response = await domainsClient.SearchDomainsAsync(location, query);

SearchDomainsAsync(SearchDomainsRequest, CallSettings)

public virtual Task<SearchDomainsResponse> SearchDomainsAsync(SearchDomainsRequest request, CallSettings callSettings = null)

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
Name Description
request SearchDomainsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskSearchDomainsResponse

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
SearchDomainsRequest request = new SearchDomainsRequest
{
    Query = "",
    LocationAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
SearchDomainsResponse response = await domainsClient.SearchDomainsAsync(request);

SearchDomainsAsync(SearchDomainsRequest, CancellationToken)

public virtual Task<SearchDomainsResponse> SearchDomainsAsync(SearchDomainsRequest request, CancellationToken cancellationToken)

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
Name Description
request SearchDomainsRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskSearchDomainsResponse

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
SearchDomainsRequest request = new SearchDomainsRequest
{
    Query = "",
    LocationAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
SearchDomainsResponse response = await domainsClient.SearchDomainsAsync(request);

SearchDomainsAsync(string, string, CallSettings)

public virtual Task<SearchDomainsResponse> SearchDomainsAsync(string location, string query, CallSettings callSettings = null)

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
Name Description
location string

Required. The location. Must be in the format projects/*/locations/*.

query string

Required. String used to search for available domain names.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskSearchDomainsResponse

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string location = "projects/[PROJECT]/locations/[LOCATION]";
string query = "";
// Make the request
SearchDomainsResponse response = await domainsClient.SearchDomainsAsync(location, query);

SearchDomainsAsync(string, string, CancellationToken)

public virtual Task<SearchDomainsResponse> SearchDomainsAsync(string location, string query, CancellationToken cancellationToken)

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
Name Description
location string

Required. The location. Must be in the format projects/*/locations/*.

query string

Required. String used to search for available domain names.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskSearchDomainsResponse

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string location = "projects/[PROJECT]/locations/[LOCATION]";
string query = "";
// Make the request
SearchDomainsResponse response = await domainsClient.SearchDomainsAsync(location, query);

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

TransferDomain(LocationName, Registration, Money, AuthorizationCode, CallSettings)

public virtual Operation<Registration, OperationMetadata> TransferDomain(LocationName parent, Registration registration, Money yearlyPrice, AuthorizationCode authorizationCode, CallSettings callSettings = null)

Transfers a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.

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.

Parameters
Name Description
parent LocationName

Required. The parent resource of the Registration. Must be in the format projects/*/locations/*.

registration Registration

Required. The complete Registration resource to be created.

You can leave registration.dns_settings unset to import the domain's current DNS configuration from its current registrar. Use this option only if you are sure that the domain's current DNS service does not cease upon transfer, as is often the case for DNS services provided for free by the registrar.

yearlyPrice Money

Required. Acknowledgement of the price to transfer or renew the domain for one year. Call RetrieveTransferParameters to obtain the price, which you must acknowledge.

authorizationCode AuthorizationCode

The domain's transfer authorization code. You can obtain this from the domain's current registrar.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Registration registration = new Registration();
Money yearlyPrice = new Money();
AuthorizationCode authorizationCode = new AuthorizationCode();
// Make the request
Operation<Registration, OperationMetadata> response = domainsClient.TransferDomain(parent, registration, yearlyPrice, authorizationCode);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = domainsClient.PollOnceTransferDomain(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

TransferDomain(TransferDomainRequest, CallSettings)

public virtual Operation<Registration, OperationMetadata> TransferDomain(TransferDomainRequest request, CallSettings callSettings = null)

Transfers a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.

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.

Parameters
Name Description
request TransferDomainRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
TransferDomainRequest request = new TransferDomainRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Registration = new Registration(),
    ContactNotices =
    {
        ContactNotice.Unspecified,
    },
    YearlyPrice = new Money(),
    AuthorizationCode = new AuthorizationCode(),
    ValidateOnly = false,
};
// Make the request
Operation<Registration, OperationMetadata> response = domainsClient.TransferDomain(request);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = domainsClient.PollOnceTransferDomain(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

TransferDomain(string, Registration, Money, AuthorizationCode, CallSettings)

public virtual Operation<Registration, OperationMetadata> TransferDomain(string parent, Registration registration, Money yearlyPrice, AuthorizationCode authorizationCode, CallSettings callSettings = null)

Transfers a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.

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.

Parameters
Name Description
parent string

Required. The parent resource of the Registration. Must be in the format projects/*/locations/*.

registration Registration

Required. The complete Registration resource to be created.

You can leave registration.dns_settings unset to import the domain's current DNS configuration from its current registrar. Use this option only if you are sure that the domain's current DNS service does not cease upon transfer, as is often the case for DNS services provided for free by the registrar.

yearlyPrice Money

Required. Acknowledgement of the price to transfer or renew the domain for one year. Call RetrieveTransferParameters to obtain the price, which you must acknowledge.

authorizationCode AuthorizationCode

The domain's transfer authorization code. You can obtain this from the domain's current registrar.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Registration registration = new Registration();
Money yearlyPrice = new Money();
AuthorizationCode authorizationCode = new AuthorizationCode();
// Make the request
Operation<Registration, OperationMetadata> response = domainsClient.TransferDomain(parent, registration, yearlyPrice, authorizationCode);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = domainsClient.PollOnceTransferDomain(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

TransferDomainAsync(LocationName, Registration, Money, AuthorizationCode, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> TransferDomainAsync(LocationName parent, Registration registration, Money yearlyPrice, AuthorizationCode authorizationCode, CallSettings callSettings = null)

Transfers a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.

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.

Parameters
Name Description
parent LocationName

Required. The parent resource of the Registration. Must be in the format projects/*/locations/*.

registration Registration

Required. The complete Registration resource to be created.

You can leave registration.dns_settings unset to import the domain's current DNS configuration from its current registrar. Use this option only if you are sure that the domain's current DNS service does not cease upon transfer, as is often the case for DNS services provided for free by the registrar.

yearlyPrice Money

Required. Acknowledgement of the price to transfer or renew the domain for one year. Call RetrieveTransferParameters to obtain the price, which you must acknowledge.

authorizationCode AuthorizationCode

The domain's transfer authorization code. You can obtain this from the domain's current registrar.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Registration registration = new Registration();
Money yearlyPrice = new Money();
AuthorizationCode authorizationCode = new AuthorizationCode();
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.TransferDomainAsync(parent, registration, yearlyPrice, authorizationCode);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceTransferDomainAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

TransferDomainAsync(LocationName, Registration, Money, AuthorizationCode, CancellationToken)

public virtual Task<Operation<Registration, OperationMetadata>> TransferDomainAsync(LocationName parent, Registration registration, Money yearlyPrice, AuthorizationCode authorizationCode, CancellationToken cancellationToken)

Transfers a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.

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.

Parameters
Name Description
parent LocationName

Required. The parent resource of the Registration. Must be in the format projects/*/locations/*.

registration Registration

Required. The complete Registration resource to be created.

You can leave registration.dns_settings unset to import the domain's current DNS configuration from its current registrar. Use this option only if you are sure that the domain's current DNS service does not cease upon transfer, as is often the case for DNS services provided for free by the registrar.

yearlyPrice Money

Required. Acknowledgement of the price to transfer or renew the domain for one year. Call RetrieveTransferParameters to obtain the price, which you must acknowledge.

authorizationCode AuthorizationCode

The domain's transfer authorization code. You can obtain this from the domain's current registrar.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Registration registration = new Registration();
Money yearlyPrice = new Money();
AuthorizationCode authorizationCode = new AuthorizationCode();
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.TransferDomainAsync(parent, registration, yearlyPrice, authorizationCode);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceTransferDomainAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

TransferDomainAsync(TransferDomainRequest, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> TransferDomainAsync(TransferDomainRequest request, CallSettings callSettings = null)

Transfers a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.

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.

Parameters
Name Description
request TransferDomainRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
TransferDomainRequest request = new TransferDomainRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Registration = new Registration(),
    ContactNotices =
    {
        ContactNotice.Unspecified,
    },
    YearlyPrice = new Money(),
    AuthorizationCode = new AuthorizationCode(),
    ValidateOnly = false,
};
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.TransferDomainAsync(request);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceTransferDomainAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

TransferDomainAsync(TransferDomainRequest, CancellationToken)

public virtual Task<Operation<Registration, OperationMetadata>> TransferDomainAsync(TransferDomainRequest request, CancellationToken cancellationToken)

Transfers a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.

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.

Parameters
Name Description
request TransferDomainRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
TransferDomainRequest request = new TransferDomainRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Registration = new Registration(),
    ContactNotices =
    {
        ContactNotice.Unspecified,
    },
    YearlyPrice = new Money(),
    AuthorizationCode = new AuthorizationCode(),
    ValidateOnly = false,
};
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.TransferDomainAsync(request);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceTransferDomainAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

TransferDomainAsync(string, Registration, Money, AuthorizationCode, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> TransferDomainAsync(string parent, Registration registration, Money yearlyPrice, AuthorizationCode authorizationCode, CallSettings callSettings = null)

Transfers a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.

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.

Parameters
Name Description
parent string

Required. The parent resource of the Registration. Must be in the format projects/*/locations/*.

registration Registration

Required. The complete Registration resource to be created.

You can leave registration.dns_settings unset to import the domain's current DNS configuration from its current registrar. Use this option only if you are sure that the domain's current DNS service does not cease upon transfer, as is often the case for DNS services provided for free by the registrar.

yearlyPrice Money

Required. Acknowledgement of the price to transfer or renew the domain for one year. Call RetrieveTransferParameters to obtain the price, which you must acknowledge.

authorizationCode AuthorizationCode

The domain's transfer authorization code. You can obtain this from the domain's current registrar.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Registration registration = new Registration();
Money yearlyPrice = new Money();
AuthorizationCode authorizationCode = new AuthorizationCode();
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.TransferDomainAsync(parent, registration, yearlyPrice, authorizationCode);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceTransferDomainAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

TransferDomainAsync(string, Registration, Money, AuthorizationCode, CancellationToken)

public virtual Task<Operation<Registration, OperationMetadata>> TransferDomainAsync(string parent, Registration registration, Money yearlyPrice, AuthorizationCode authorizationCode, CancellationToken cancellationToken)

Transfers a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.

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.

Parameters
Name Description
parent string

Required. The parent resource of the Registration. Must be in the format projects/*/locations/*.

registration Registration

Required. The complete Registration resource to be created.

You can leave registration.dns_settings unset to import the domain's current DNS configuration from its current registrar. Use this option only if you are sure that the domain's current DNS service does not cease upon transfer, as is often the case for DNS services provided for free by the registrar.

yearlyPrice Money

Required. Acknowledgement of the price to transfer or renew the domain for one year. Call RetrieveTransferParameters to obtain the price, which you must acknowledge.

authorizationCode AuthorizationCode

The domain's transfer authorization code. You can obtain this from the domain's current registrar.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Registration registration = new Registration();
Money yearlyPrice = new Money();
AuthorizationCode authorizationCode = new AuthorizationCode();
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.TransferDomainAsync(parent, registration, yearlyPrice, authorizationCode);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceTransferDomainAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

UpdateRegistration(Registration, FieldMask, CallSettings)

public virtual Operation<Registration, OperationMetadata> UpdateRegistration(Registration registration, FieldMask updateMask, CallSettings callSettings = null)

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
Name Description
registration Registration

Fields of the Registration to update.

updateMask FieldMask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the labels are being updated, the update_mask is "labels".

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
Registration registration = new Registration();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Registration, OperationMetadata> response = domainsClient.UpdateRegistration(registration, updateMask);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = domainsClient.PollOnceUpdateRegistration(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

UpdateRegistration(UpdateRegistrationRequest, CallSettings)

public virtual Operation<Registration, OperationMetadata> UpdateRegistration(UpdateRegistrationRequest request, CallSettings callSettings = null)

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
Name Description
request UpdateRegistrationRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRegistrationOperationMetadata

The RPC response.

Example
// Create client
DomainsClient domainsClient = DomainsClient.Create();
// Initialize request argument(s)
UpdateRegistrationRequest request = new UpdateRegistrationRequest
{
    Registration = new Registration(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<Registration, OperationMetadata> response = domainsClient.UpdateRegistration(request);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = domainsClient.PollOnceUpdateRegistration(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

UpdateRegistrationAsync(Registration, FieldMask, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> UpdateRegistrationAsync(Registration registration, FieldMask updateMask, CallSettings callSettings = null)

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
Name Description
registration Registration

Fields of the Registration to update.

updateMask FieldMask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the labels are being updated, the update_mask is "labels".

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
Registration registration = new Registration();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.UpdateRegistrationAsync(registration, updateMask);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceUpdateRegistrationAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

UpdateRegistrationAsync(Registration, FieldMask, CancellationToken)

public virtual Task<Operation<Registration, OperationMetadata>> UpdateRegistrationAsync(Registration registration, FieldMask updateMask, CancellationToken cancellationToken)

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
Name Description
registration Registration

Fields of the Registration to update.

updateMask FieldMask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the labels are being updated, the update_mask is "labels".

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
Registration registration = new Registration();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.UpdateRegistrationAsync(registration, updateMask);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceUpdateRegistrationAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

UpdateRegistrationAsync(UpdateRegistrationRequest, CallSettings)

public virtual Task<Operation<Registration, OperationMetadata>> UpdateRegistrationAsync(UpdateRegistrationRequest request, CallSettings callSettings = null)

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
Name Description
request UpdateRegistrationRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
UpdateRegistrationRequest request = new UpdateRegistrationRequest
{
    Registration = new Registration(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.UpdateRegistrationAsync(request);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceUpdateRegistrationAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}

UpdateRegistrationAsync(UpdateRegistrationRequest, CancellationToken)

public virtual Task<Operation<Registration, OperationMetadata>> UpdateRegistrationAsync(UpdateRegistrationRequest request, CancellationToken cancellationToken)

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
Name Description
request UpdateRegistrationRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRegistrationOperationMetadata

A Task containing the RPC response.

Example
// Create client
DomainsClient domainsClient = await DomainsClient.CreateAsync();
// Initialize request argument(s)
UpdateRegistrationRequest request = new UpdateRegistrationRequest
{
    Registration = new Registration(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<Registration, OperationMetadata> response = await domainsClient.UpdateRegistrationAsync(request);

// Poll until the returned long-running operation is complete
Operation<Registration, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Registration result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Registration, OperationMetadata> retrievedResponse = await domainsClient.PollOnceUpdateRegistrationAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Registration retrievedResult = retrievedResponse.Result;
}