App Engine v1 API - Class DomainMappingsClientImpl (2.3.0)

Version 2.3.0

• 2.4.0 (latest)
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class DomainMappingsClientImpl : DomainMappingsClient

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

DomainMappings client wrapper implementation, for convenient use.

Inheritance

object > DomainMappingsClient > DomainMappingsClientImpl

Inherited Members

DomainMappingsClient.DefaultEndpoint

DomainMappingsClient.DefaultScopes

DomainMappingsClient.ServiceMetadata

DomainMappingsClient.CreateAsync(CancellationToken)

DomainMappingsClient.Create()

DomainMappingsClient.ShutdownDefaultChannelsAsync()

DomainMappingsClient.GetDomainMappingAsync(GetDomainMappingRequest, CancellationToken)

DomainMappingsClient.CreateDomainMappingAsync(CreateDomainMappingRequest, CancellationToken)

DomainMappingsClient.PollOnceCreateDomainMapping(string, CallSettings)

DomainMappingsClient.PollOnceCreateDomainMappingAsync(string, CallSettings)

DomainMappingsClient.UpdateDomainMappingAsync(UpdateDomainMappingRequest, CancellationToken)

DomainMappingsClient.PollOnceUpdateDomainMapping(string, CallSettings)

DomainMappingsClient.PollOnceUpdateDomainMappingAsync(string, CallSettings)

DomainMappingsClient.DeleteDomainMappingAsync(DeleteDomainMappingRequest, CancellationToken)

DomainMappingsClient.PollOnceDeleteDomainMapping(string, CallSettings)

DomainMappingsClient.PollOnceDeleteDomainMappingAsync(string, CallSettings)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AppEngine.V1

Assembly

Google.Cloud.AppEngine.V1.dll

Remarks

Manages domains serving an application.

Constructors

DomainMappingsClientImpl(DomainMappingsClient, DomainMappingsSettings, ILogger)

public DomainMappingsClientImpl(DomainMappings.DomainMappingsClient grpcClient, DomainMappingsSettings settings, ILogger logger)

Constructs a client wrapper for the DomainMappings service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	DomainMappingsDomainMappingsClient The underlying gRPC client.
settings	DomainMappingsSettings The base DomainMappingsSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

CreateDomainMappingOperationsClient

public override OperationsClient CreateDomainMappingOperationsClient { get; }

The long-running operations client for CreateDomainMapping.

Property Value
Type	Description
OperationsClient

Overrides

DomainMappingsClient.CreateDomainMappingOperationsClient

DeleteDomainMappingOperationsClient

public override OperationsClient DeleteDomainMappingOperationsClient { get; }

The long-running operations client for DeleteDomainMapping.

Property Value
Type	Description
OperationsClient

Overrides

DomainMappingsClient.DeleteDomainMappingOperationsClient

GrpcClient

public override DomainMappings.DomainMappingsClient GrpcClient { get; }

The underlying gRPC DomainMappings client

Property Value
Type	Description
DomainMappingsDomainMappingsClient

Overrides

DomainMappingsClient.GrpcClient

UpdateDomainMappingOperationsClient

public override OperationsClient UpdateDomainMappingOperationsClient { get; }

The long-running operations client for UpdateDomainMapping.

Property Value
Type	Description
OperationsClient

Overrides

DomainMappingsClient.UpdateDomainMappingOperationsClient

Methods

CreateDomainMapping(CreateDomainMappingRequest, CallSettings)

public override 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
Name	Description
request	CreateDomainMappingRequest 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
OperationDomainMappingOperationMetadataV1	The RPC response.

Overrides

DomainMappingsClient.CreateDomainMapping(CreateDomainMappingRequest, CallSettings)

CreateDomainMappingAsync(CreateDomainMappingRequest, CallSettings)

public override 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
Name	Description
request	CreateDomainMappingRequest 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
TaskOperationDomainMappingOperationMetadataV1	A Task containing the RPC response.

Overrides

DomainMappingsClient.CreateDomainMappingAsync(CreateDomainMappingRequest, CallSettings)

DeleteDomainMapping(DeleteDomainMappingRequest, CallSettings)

public override 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
Name	Description
request	DeleteDomainMappingRequest 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
OperationEmptyOperationMetadataV1	The RPC response.

Overrides

DomainMappingsClient.DeleteDomainMapping(DeleteDomainMappingRequest, CallSettings)

DeleteDomainMappingAsync(DeleteDomainMappingRequest, CallSettings)

public override 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
Name	Description
request	DeleteDomainMappingRequest 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
TaskOperationEmptyOperationMetadataV1	A Task containing the RPC response.

Overrides

DomainMappingsClient.DeleteDomainMappingAsync(DeleteDomainMappingRequest, CallSettings)

GetDomainMapping(GetDomainMappingRequest, CallSettings)

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

Gets the specified domain mapping.

Parameters
Name	Description
request	GetDomainMappingRequest 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
DomainMapping	The RPC response.

Overrides

DomainMappingsClient.GetDomainMapping(GetDomainMappingRequest, CallSettings)

GetDomainMappingAsync(GetDomainMappingRequest, CallSettings)

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

Gets the specified domain mapping.

Parameters
Name	Description
request	GetDomainMappingRequest 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
TaskDomainMapping	A Task containing the RPC response.

Overrides

DomainMappingsClient.GetDomainMappingAsync(GetDomainMappingRequest, CallSettings)

ListDomainMappings(ListDomainMappingsRequest, CallSettings)

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

Lists the domain mappings on an application.

Parameters
Name	Description
request	ListDomainMappingsRequest 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
PagedEnumerableListDomainMappingsResponseDomainMapping	A pageable sequence of DomainMapping resources.

Overrides

DomainMappingsClient.ListDomainMappings(ListDomainMappingsRequest, CallSettings)

ListDomainMappingsAsync(ListDomainMappingsRequest, CallSettings)

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

Lists the domain mappings on an application.

Parameters
Name	Description
request	ListDomainMappingsRequest 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
PagedAsyncEnumerableListDomainMappingsResponseDomainMapping	A pageable asynchronous sequence of DomainMapping resources.

Overrides

DomainMappingsClient.ListDomainMappingsAsync(ListDomainMappingsRequest, CallSettings)

UpdateDomainMapping(UpdateDomainMappingRequest, CallSettings)

public override 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
Name	Description
request	UpdateDomainMappingRequest 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
OperationDomainMappingOperationMetadataV1	The RPC response.

Overrides

DomainMappingsClient.UpdateDomainMapping(UpdateDomainMappingRequest, CallSettings)

UpdateDomainMappingAsync(UpdateDomainMappingRequest, CallSettings)

public override 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
Name	Description
request	UpdateDomainMappingRequest 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
TaskOperationDomainMappingOperationMetadataV1	A Task containing the RPC response.

Overrides

DomainMappingsClient.UpdateDomainMappingAsync(UpdateDomainMappingRequest, CallSettings)