App Engine v1 API - Class DomainMappingsClient (2.2.0)

public abstract class DomainMappingsClient

Reference documentation and code samples for the App Engine v1 API class DomainMappingsClient.

DomainMappings client wrapper, for convenient use.

Inheritance

object > DomainMappingsClient

Derived Types

Namespace

Google.Cloud.AppEngine.V1

Assembly

Google.Cloud.AppEngine.V1.dll

Remarks

Manages domains serving an application.

Properties

CreateDomainMappingOperationsClient

public virtual OperationsClient CreateDomainMappingOperationsClient { get; }

The long-running operations client for CreateDomainMapping.

Property Value
TypeDescription
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
TypeDescription
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default DomainMappings scopes.

Property Value
TypeDescription
IReadOnlyListstring
Remarks

DeleteDomainMappingOperationsClient

public virtual OperationsClient DeleteDomainMappingOperationsClient { get; }

The long-running operations client for DeleteDomainMapping.

Property Value
TypeDescription
OperationsClient

GrpcClient

public virtual DomainMappings.DomainMappingsClient GrpcClient { get; }

The underlying gRPC DomainMappings client

Property Value
TypeDescription
DomainMappingsDomainMappingsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
TypeDescription
ServiceMetadata

UpdateDomainMappingOperationsClient

public virtual OperationsClient UpdateDomainMappingOperationsClient { get; }

The long-running operations client for UpdateDomainMapping.

Property Value
TypeDescription
OperationsClient

Methods

Create()

public static DomainMappingsClient Create()

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

Returns
TypeDescription
DomainMappingsClient

The created DomainMappingsClient.

CreateAsync(CancellationToken)

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

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

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
TaskDomainMappingsClient

The task representing the created DomainMappingsClient.

CreateDomainMapping(CreateDomainMappingRequest, CallSettings)

public virtual Operation<DomainMapping, OperationMetadataV1> CreateDomainMapping(CreateDomainMappingRequest request, CallSettings callSettings = null)

Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.

Parameters
NameDescription
requestCreateDomainMappingRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationDomainMappingOperationMetadataV1

The RPC response.

Example
// Create client
DomainMappingsClient domainMappingsClient = DomainMappingsClient.Create();
// Initialize request argument(s)
CreateDomainMappingRequest request = new CreateDomainMappingRequest
{
    Parent = "",
    DomainMapping = new DomainMapping(),
    OverrideStrategy = DomainOverrideStrategy.UnspecifiedDomainOverrideStrategy,
};
// Make the request
Operation<DomainMapping, OperationMetadataV1> response = domainMappingsClient.CreateDomainMapping(request);

// Poll until the returned long-running operation is complete
Operation<DomainMapping, OperationMetadataV1> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
DomainMapping 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<DomainMapping, OperationMetadataV1> retrievedResponse = domainMappingsClient.PollOnceCreateDomainMapping(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DomainMapping retrievedResult = retrievedResponse.Result;
}

CreateDomainMappingAsync(CreateDomainMappingRequest, CallSettings)

public virtual Task<Operation<DomainMapping, OperationMetadataV1>> CreateDomainMappingAsync(CreateDomainMappingRequest request, CallSettings callSettings = null)

Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.

Parameters
NameDescription
requestCreateDomainMappingRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationDomainMappingOperationMetadataV1

A Task containing the RPC response.

Example
// Create client
DomainMappingsClient domainMappingsClient = await DomainMappingsClient.CreateAsync();
// Initialize request argument(s)
CreateDomainMappingRequest request = new CreateDomainMappingRequest
{
    Parent = "",
    DomainMapping = new DomainMapping(),
    OverrideStrategy = DomainOverrideStrategy.UnspecifiedDomainOverrideStrategy,
};
// Make the request
Operation<DomainMapping, OperationMetadataV1> response = await domainMappingsClient.CreateDomainMappingAsync(request);

// Poll until the returned long-running operation is complete
Operation<DomainMapping, OperationMetadataV1> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DomainMapping 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<DomainMapping, OperationMetadataV1> retrievedResponse = await domainMappingsClient.PollOnceCreateDomainMappingAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DomainMapping retrievedResult = retrievedResponse.Result;
}

CreateDomainMappingAsync(CreateDomainMappingRequest, CancellationToken)

public virtual Task<Operation<DomainMapping, OperationMetadataV1>> CreateDomainMappingAsync(CreateDomainMappingRequest request, CancellationToken cancellationToken)

Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.

Parameters
NameDescription
requestCreateDomainMappingRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationDomainMappingOperationMetadataV1

A Task containing the RPC response.

Example
// Create client
DomainMappingsClient domainMappingsClient = await DomainMappingsClient.CreateAsync();
// Initialize request argument(s)
CreateDomainMappingRequest request = new CreateDomainMappingRequest
{
    Parent = "",
    DomainMapping = new DomainMapping(),
    OverrideStrategy = DomainOverrideStrategy.UnspecifiedDomainOverrideStrategy,
};
// Make the request
Operation<DomainMapping, OperationMetadataV1> response = await domainMappingsClient.CreateDomainMappingAsync(request);

// Poll until the returned long-running operation is complete
Operation<DomainMapping, OperationMetadataV1> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DomainMapping 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<DomainMapping, OperationMetadataV1> retrievedResponse = await domainMappingsClient.PollOnceCreateDomainMappingAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DomainMapping retrievedResult = retrievedResponse.Result;
}

DeleteDomainMapping(DeleteDomainMappingRequest, CallSettings)

public virtual Operation<Empty, OperationMetadataV1> DeleteDomainMapping(DeleteDomainMappingRequest request, CallSettings callSettings = null)

Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.

Parameters
NameDescription
requestDeleteDomainMappingRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyOperationMetadataV1

The RPC response.

Example
// Create client
DomainMappingsClient domainMappingsClient = DomainMappingsClient.Create();
// Initialize request argument(s)
DeleteDomainMappingRequest request = new DeleteDomainMappingRequest { Name = "", };
// Make the request
Operation<Empty, OperationMetadataV1> response = domainMappingsClient.DeleteDomainMapping(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadataV1> 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, OperationMetadataV1> retrievedResponse = domainMappingsClient.PollOnceDeleteDomainMapping(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;
}

DeleteDomainMappingAsync(DeleteDomainMappingRequest, CallSettings)

public virtual Task<Operation<Empty, OperationMetadataV1>> DeleteDomainMappingAsync(DeleteDomainMappingRequest request, CallSettings callSettings = null)

Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.

Parameters
NameDescription
requestDeleteDomainMappingRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyOperationMetadataV1

A Task containing the RPC response.

Example
// Create client
DomainMappingsClient domainMappingsClient = await DomainMappingsClient.CreateAsync();
// Initialize request argument(s)
DeleteDomainMappingRequest request = new DeleteDomainMappingRequest { Name = "", };
// Make the request
Operation<Empty, OperationMetadataV1> response = await domainMappingsClient.DeleteDomainMappingAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadataV1> 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, OperationMetadataV1> retrievedResponse = await domainMappingsClient.PollOnceDeleteDomainMappingAsync(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;
}

DeleteDomainMappingAsync(DeleteDomainMappingRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadataV1>> DeleteDomainMappingAsync(DeleteDomainMappingRequest request, CancellationToken cancellationToken)

Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.

Parameters
NameDescription
requestDeleteDomainMappingRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEmptyOperationMetadataV1

A Task containing the RPC response.

Example
// Create client
DomainMappingsClient domainMappingsClient = await DomainMappingsClient.CreateAsync();
// Initialize request argument(s)
DeleteDomainMappingRequest request = new DeleteDomainMappingRequest { Name = "", };
// Make the request
Operation<Empty, OperationMetadataV1> response = await domainMappingsClient.DeleteDomainMappingAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadataV1> 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, OperationMetadataV1> retrievedResponse = await domainMappingsClient.PollOnceDeleteDomainMappingAsync(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;
}

GetDomainMapping(GetDomainMappingRequest, CallSettings)

public virtual DomainMapping GetDomainMapping(GetDomainMappingRequest request, CallSettings callSettings = null)

Gets the specified domain mapping.

Parameters
NameDescription
requestGetDomainMappingRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
DomainMapping

The RPC response.

Example
// Create client
DomainMappingsClient domainMappingsClient = DomainMappingsClient.Create();
// Initialize request argument(s)
GetDomainMappingRequest request = new GetDomainMappingRequest { Name = "", };
// Make the request
DomainMapping response = domainMappingsClient.GetDomainMapping(request);

GetDomainMappingAsync(GetDomainMappingRequest, CallSettings)

public virtual Task<DomainMapping> GetDomainMappingAsync(GetDomainMappingRequest request, CallSettings callSettings = null)

Gets the specified domain mapping.

Parameters
NameDescription
requestGetDomainMappingRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskDomainMapping

A Task containing the RPC response.

Example
// Create client
DomainMappingsClient domainMappingsClient = await DomainMappingsClient.CreateAsync();
// Initialize request argument(s)
GetDomainMappingRequest request = new GetDomainMappingRequest { Name = "", };
// Make the request
DomainMapping response = await domainMappingsClient.GetDomainMappingAsync(request);

GetDomainMappingAsync(GetDomainMappingRequest, CancellationToken)

public virtual Task<DomainMapping> GetDomainMappingAsync(GetDomainMappingRequest request, CancellationToken cancellationToken)

Gets the specified domain mapping.

Parameters
NameDescription
requestGetDomainMappingRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskDomainMapping

A Task containing the RPC response.

Example
// Create client
DomainMappingsClient domainMappingsClient = await DomainMappingsClient.CreateAsync();
// Initialize request argument(s)
GetDomainMappingRequest request = new GetDomainMappingRequest { Name = "", };
// Make the request
DomainMapping response = await domainMappingsClient.GetDomainMappingAsync(request);

ListDomainMappings(ListDomainMappingsRequest, CallSettings)

public virtual PagedEnumerable<ListDomainMappingsResponse, DomainMapping> ListDomainMappings(ListDomainMappingsRequest request, CallSettings callSettings = null)

Lists the domain mappings on an application.

Parameters
NameDescription
requestListDomainMappingsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListDomainMappingsResponseDomainMapping

A pageable sequence of DomainMapping resources.

Example
// Create client
DomainMappingsClient domainMappingsClient = DomainMappingsClient.Create();
// Initialize request argument(s)
ListDomainMappingsRequest request = new ListDomainMappingsRequest { Parent = "", };
// Make the request
PagedEnumerable<ListDomainMappingsResponse, DomainMapping> response = domainMappingsClient.ListDomainMappings(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (DomainMapping 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 (ListDomainMappingsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DomainMapping 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<DomainMapping> 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 (DomainMapping 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;

ListDomainMappingsAsync(ListDomainMappingsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListDomainMappingsResponse, DomainMapping> ListDomainMappingsAsync(ListDomainMappingsRequest request, CallSettings callSettings = null)

Lists the domain mappings on an application.

Parameters
NameDescription
requestListDomainMappingsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListDomainMappingsResponseDomainMapping

A pageable asynchronous sequence of DomainMapping resources.

Example
// Create client
DomainMappingsClient domainMappingsClient = await DomainMappingsClient.CreateAsync();
// Initialize request argument(s)
ListDomainMappingsRequest request = new ListDomainMappingsRequest { Parent = "", };
// Make the request
PagedAsyncEnumerable<ListDomainMappingsResponse, DomainMapping> response = domainMappingsClient.ListDomainMappingsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((DomainMapping 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((ListDomainMappingsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DomainMapping 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<DomainMapping> 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 (DomainMapping 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;

PollOnceCreateDomainMapping(string, CallSettings)

public virtual Operation<DomainMapping, OperationMetadataV1> PollOnceCreateDomainMapping(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationDomainMappingOperationMetadataV1

The result of polling the operation.

PollOnceCreateDomainMappingAsync(string, CallSettings)

public virtual Task<Operation<DomainMapping, OperationMetadataV1>> PollOnceCreateDomainMappingAsync(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationDomainMappingOperationMetadataV1

A task representing the result of polling the operation.

PollOnceDeleteDomainMapping(string, CallSettings)

public virtual Operation<Empty, OperationMetadataV1> PollOnceDeleteDomainMapping(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyOperationMetadataV1

The result of polling the operation.

PollOnceDeleteDomainMappingAsync(string, CallSettings)

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

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

Parameters
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyOperationMetadataV1

A task representing the result of polling the operation.

PollOnceUpdateDomainMapping(string, CallSettings)

public virtual Operation<DomainMapping, OperationMetadataV1> PollOnceUpdateDomainMapping(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationDomainMappingOperationMetadataV1

The result of polling the operation.

PollOnceUpdateDomainMappingAsync(string, CallSettings)

public virtual Task<Operation<DomainMapping, OperationMetadataV1>> PollOnceUpdateDomainMappingAsync(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationDomainMappingOperationMetadataV1

A task representing the result of polling the operation.

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
TypeDescription
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.

UpdateDomainMapping(UpdateDomainMappingRequest, CallSettings)

public virtual Operation<DomainMapping, OperationMetadataV1> UpdateDomainMapping(UpdateDomainMappingRequest request, CallSettings callSettings = null)

Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.

Parameters
NameDescription
requestUpdateDomainMappingRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationDomainMappingOperationMetadataV1

The RPC response.

Example
// Create client
DomainMappingsClient domainMappingsClient = DomainMappingsClient.Create();
// Initialize request argument(s)
UpdateDomainMappingRequest request = new UpdateDomainMappingRequest
{
    Name = "",
    DomainMapping = new DomainMapping(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<DomainMapping, OperationMetadataV1> response = domainMappingsClient.UpdateDomainMapping(request);

// Poll until the returned long-running operation is complete
Operation<DomainMapping, OperationMetadataV1> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
DomainMapping 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<DomainMapping, OperationMetadataV1> retrievedResponse = domainMappingsClient.PollOnceUpdateDomainMapping(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DomainMapping retrievedResult = retrievedResponse.Result;
}

UpdateDomainMappingAsync(UpdateDomainMappingRequest, CallSettings)

public virtual Task<Operation<DomainMapping, OperationMetadataV1>> UpdateDomainMappingAsync(UpdateDomainMappingRequest request, CallSettings callSettings = null)

Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.

Parameters
NameDescription
requestUpdateDomainMappingRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationDomainMappingOperationMetadataV1

A Task containing the RPC response.

Example
// Create client
DomainMappingsClient domainMappingsClient = await DomainMappingsClient.CreateAsync();
// Initialize request argument(s)
UpdateDomainMappingRequest request = new UpdateDomainMappingRequest
{
    Name = "",
    DomainMapping = new DomainMapping(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<DomainMapping, OperationMetadataV1> response = await domainMappingsClient.UpdateDomainMappingAsync(request);

// Poll until the returned long-running operation is complete
Operation<DomainMapping, OperationMetadataV1> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DomainMapping 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<DomainMapping, OperationMetadataV1> retrievedResponse = await domainMappingsClient.PollOnceUpdateDomainMappingAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DomainMapping retrievedResult = retrievedResponse.Result;
}

UpdateDomainMappingAsync(UpdateDomainMappingRequest, CancellationToken)

public virtual Task<Operation<DomainMapping, OperationMetadataV1>> UpdateDomainMappingAsync(UpdateDomainMappingRequest request, CancellationToken cancellationToken)

Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.

Parameters
NameDescription
requestUpdateDomainMappingRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationDomainMappingOperationMetadataV1

A Task containing the RPC response.

Example
// Create client
DomainMappingsClient domainMappingsClient = await DomainMappingsClient.CreateAsync();
// Initialize request argument(s)
UpdateDomainMappingRequest request = new UpdateDomainMappingRequest
{
    Name = "",
    DomainMapping = new DomainMapping(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<DomainMapping, OperationMetadataV1> response = await domainMappingsClient.UpdateDomainMappingAsync(request);

// Poll until the returned long-running operation is complete
Operation<DomainMapping, OperationMetadataV1> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DomainMapping 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<DomainMapping, OperationMetadataV1> retrievedResponse = await domainMappingsClient.PollOnceUpdateDomainMappingAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DomainMapping retrievedResult = retrievedResponse.Result;
}