App Engine v1 API - Class DomainMappings.DomainMappingsClient (2.4.0) 

public class DomainMappings.DomainMappingsClient : ClientBase<DomainMappings.DomainMappingsClient>

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

Client for DomainMappings

Inheritance

object > ClientBase > ClientBaseDomainMappingsDomainMappingsClient > DomainMappings.DomainMappingsClient

Namespace

Google.Cloud.AppEngine.V1

Assembly

Google.Cloud.AppEngine.V1.dll

Constructors

DomainMappingsClient()

protected DomainMappingsClient()

Protected parameterless constructor to allow creation of test doubles.

DomainMappingsClient(CallInvoker)

public DomainMappingsClient(CallInvoker callInvoker)

Creates a new client for DomainMappings that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

DomainMappingsClient(ChannelBase)

public DomainMappingsClient(ChannelBase channel)

Creates a new client for DomainMappings

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

DomainMappingsClient(ClientBaseConfiguration)

protected DomainMappingsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateDomainMapping(CreateDomainMappingRequest, CallOptions)

public virtual Operation CreateDomainMapping(CreateDomainMappingRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

CreateDomainMapping(CreateDomainMappingRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateDomainMapping(CreateDomainMappingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

CreateDomainMappingAsync(CreateDomainMappingRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateDomainMappingAsync(CreateDomainMappingRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateDomainMappingAsync(CreateDomainMappingRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateDomainMappingAsync(CreateDomainMappingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

DeleteDomainMapping(DeleteDomainMappingRequest, CallOptions)

public virtual Operation DeleteDomainMapping(DeleteDomainMappingRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

DeleteDomainMapping(DeleteDomainMappingRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteDomainMapping(DeleteDomainMappingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

DeleteDomainMappingAsync(DeleteDomainMappingRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteDomainMappingAsync(DeleteDomainMappingRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteDomainMappingAsync(DeleteDomainMappingRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteDomainMappingAsync(DeleteDomainMappingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

GetDomainMapping(GetDomainMappingRequest, CallOptions)

public virtual DomainMapping GetDomainMapping(GetDomainMappingRequest request, CallOptions options)

Gets the specified domain mapping.

Parameters
Name Description
request GetDomainMappingRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
DomainMapping

The response received from the server.

GetDomainMapping(GetDomainMappingRequest, Metadata, DateTime?, CancellationToken)

public virtual DomainMapping GetDomainMapping(GetDomainMappingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the specified domain mapping.

Parameters
Name Description
request GetDomainMappingRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
DomainMapping

The response received from the server.

GetDomainMappingAsync(GetDomainMappingRequest, CallOptions)

public virtual AsyncUnaryCall<DomainMapping> GetDomainMappingAsync(GetDomainMappingRequest request, CallOptions options)

Gets the specified domain mapping.

Parameters
Name Description
request GetDomainMappingRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallDomainMapping

The call object.

GetDomainMappingAsync(GetDomainMappingRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DomainMapping> GetDomainMappingAsync(GetDomainMappingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the specified domain mapping.

Parameters
Name Description
request GetDomainMappingRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallDomainMapping

The call object.

ListDomainMappings(ListDomainMappingsRequest, CallOptions)

public virtual ListDomainMappingsResponse ListDomainMappings(ListDomainMappingsRequest request, CallOptions options)

Lists the domain mappings on an application.

Parameters
Name Description
request ListDomainMappingsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListDomainMappingsResponse

The response received from the server.

ListDomainMappings(ListDomainMappingsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListDomainMappingsResponse ListDomainMappings(ListDomainMappingsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the domain mappings on an application.

Parameters
Name Description
request ListDomainMappingsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ListDomainMappingsResponse

The response received from the server.

ListDomainMappingsAsync(ListDomainMappingsRequest, CallOptions)

public virtual AsyncUnaryCall<ListDomainMappingsResponse> ListDomainMappingsAsync(ListDomainMappingsRequest request, CallOptions options)

Lists the domain mappings on an application.

Parameters
Name Description
request ListDomainMappingsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListDomainMappingsResponse

The call object.

ListDomainMappingsAsync(ListDomainMappingsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListDomainMappingsResponse> ListDomainMappingsAsync(ListDomainMappingsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the domain mappings on an application.

Parameters
Name Description
request ListDomainMappingsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallListDomainMappingsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override DomainMappings.DomainMappingsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
DomainMappingsDomainMappingsClient
Overrides

UpdateDomainMapping(UpdateDomainMappingRequest, CallOptions)

public virtual Operation UpdateDomainMapping(UpdateDomainMappingRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

UpdateDomainMapping(UpdateDomainMappingRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateDomainMapping(UpdateDomainMappingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

UpdateDomainMappingAsync(UpdateDomainMappingRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateDomainMappingAsync(UpdateDomainMappingRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateDomainMappingAsync(UpdateDomainMappingRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateDomainMappingAsync(UpdateDomainMappingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.