Class DomainMappingsClient (2.5.0)

Version 2.5.0

• 2.49.0 (latest)
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.4
• 2.2.0
• 2.1.10
• 0.2.0

public class DomainMappingsClient implements BackgroundResource

Service Description: Manages domains serving an application.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DomainMappingsClient domainMappingsClient = DomainMappingsClient.create()) {
   GetDomainMappingRequest request =
       GetDomainMappingRequest.newBuilder().setName("name3373707").build();
   DomainMapping response = domainMappingsClient.getDomainMapping(request);
 }
 

Note: close() needs to be called on the DomainMappingsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of DomainMappingsSettings to create(). For example:

To customize credentials:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DomainMappingsSettings domainMappingsSettings =
     DomainMappingsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DomainMappingsClient domainMappingsClient = DomainMappingsClient.create(domainMappingsSettings);
 

To customize the endpoint:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DomainMappingsSettings domainMappingsSettings =
     DomainMappingsSettings.newBuilder().setEndpoint(myEndpoint).build();
 DomainMappingsClient domainMappingsClient = DomainMappingsClient.create(domainMappingsSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DomainMappingsSettings domainMappingsSettings =
     DomainMappingsSettings.newBuilder()
         .setTransportChannelProvider(
             DomainMappingsSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 DomainMappingsClient domainMappingsClient = DomainMappingsClient.create(domainMappingsSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > DomainMappingsClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final DomainMappingsClient create()

Constructs an instance of DomainMappingsClient with default settings.

Returns

Type	Description
DomainMappingsClient

Exceptions

Type	Description
IOException

create(DomainMappingsSettings settings)

public static final DomainMappingsClient create(DomainMappingsSettings settings)

Constructs an instance of DomainMappingsClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter

Name	Description
settings	DomainMappingsSettings

Returns

Type	Description
DomainMappingsClient

Exceptions

Type	Description
IOException

create(DomainMappingsStub stub)

public static final DomainMappingsClient create(DomainMappingsStub stub)

Constructs an instance of DomainMappingsClient, using the given stub for making calls. This is for advanced usage - prefer using create(DomainMappingsSettings).

Parameter

Name	Description
stub	DomainMappingsStub

Returns

Type	Description
DomainMappingsClient

Constructors

DomainMappingsClient(DomainMappingsSettings settings)

protected DomainMappingsClient(DomainMappingsSettings settings)

Constructs an instance of DomainMappingsClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter

Name	Description
settings	DomainMappingsSettings

DomainMappingsClient(DomainMappingsStub stub)

protected DomainMappingsClient(DomainMappingsStub stub)

Parameter

Name	Description
stub	DomainMappingsStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	long
unit	TimeUnit

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

close()

public final void close()

createDomainMappingAsync(CreateDomainMappingRequest request)

public final OperationFuture<DomainMapping,OperationMetadataV1> createDomainMappingAsync(CreateDomainMappingRequest request)

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.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DomainMappingsClient domainMappingsClient = DomainMappingsClient.create()) {
   CreateDomainMappingRequest request =
       CreateDomainMappingRequest.newBuilder()
           .setParent("parent-995424086")
           .setDomainMapping(DomainMapping.newBuilder().build())
           .setOverrideStrategy(DomainOverrideStrategy.forNumber(0))
           .build();
   DomainMapping response = domainMappingsClient.createDomainMappingAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<DomainMapping,OperationMetadataV1>

createDomainMappingCallable()

public final UnaryCallable<CreateDomainMappingRequest,Operation> createDomainMappingCallable()

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.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DomainMappingsClient domainMappingsClient = DomainMappingsClient.create()) {
   CreateDomainMappingRequest request =
       CreateDomainMappingRequest.newBuilder()
           .setParent("parent-995424086")
           .setDomainMapping(DomainMapping.newBuilder().build())
           .setOverrideStrategy(DomainOverrideStrategy.forNumber(0))
           .build();
   ApiFuture<Operation> future =
       domainMappingsClient.createDomainMappingCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<CreateDomainMappingRequest,Operation>

createDomainMappingOperationCallable()

public final OperationCallable<CreateDomainMappingRequest,DomainMapping,OperationMetadataV1> createDomainMappingOperationCallable()

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.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DomainMappingsClient domainMappingsClient = DomainMappingsClient.create()) {
   CreateDomainMappingRequest request =
       CreateDomainMappingRequest.newBuilder()
           .setParent("parent-995424086")
           .setDomainMapping(DomainMapping.newBuilder().build())
           .setOverrideStrategy(DomainOverrideStrategy.forNumber(0))
           .build();
   OperationFuture<DomainMapping, OperationMetadataV1> future =
       domainMappingsClient.createDomainMappingOperationCallable().futureCall(request);
   // Do something.
   DomainMapping response = future.get();
 }
 

Returns

Type	Description
OperationCallable<CreateDomainMappingRequest,DomainMapping,OperationMetadataV1>

deleteDomainMappingAsync(DeleteDomainMappingRequest request)

public final OperationFuture<Empty,OperationMetadataV1> deleteDomainMappingAsync(DeleteDomainMappingRequest request)

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

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DomainMappingsClient domainMappingsClient = DomainMappingsClient.create()) {
   DeleteDomainMappingRequest request =
       DeleteDomainMappingRequest.newBuilder().setName("name3373707").build();
   domainMappingsClient.deleteDomainMappingAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Empty,OperationMetadataV1>

deleteDomainMappingCallable()

public final UnaryCallable<DeleteDomainMappingRequest,Operation> deleteDomainMappingCallable()

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

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DomainMappingsClient domainMappingsClient = DomainMappingsClient.create()) {
   DeleteDomainMappingRequest request =
       DeleteDomainMappingRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Operation> future =
       domainMappingsClient.deleteDomainMappingCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns

Type	Description
UnaryCallable<DeleteDomainMappingRequest,Operation>

deleteDomainMappingOperationCallable()

public final OperationCallable<DeleteDomainMappingRequest,Empty,OperationMetadataV1> deleteDomainMappingOperationCallable()

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

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DomainMappingsClient domainMappingsClient = DomainMappingsClient.create()) {
   DeleteDomainMappingRequest request =
       DeleteDomainMappingRequest.newBuilder().setName("name3373707").build();
   OperationFuture<Empty, OperationMetadataV1> future =
       domainMappingsClient.deleteDomainMappingOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns

Type	Description
OperationCallable<DeleteDomainMappingRequest,Empty,OperationMetadataV1>

getDomainMapping(GetDomainMappingRequest request)

public final DomainMapping getDomainMapping(GetDomainMappingRequest request)

Gets the specified domain mapping.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DomainMappingsClient domainMappingsClient = DomainMappingsClient.create()) {
   GetDomainMappingRequest request =
       GetDomainMappingRequest.newBuilder().setName("name3373707").build();
   DomainMapping response = domainMappingsClient.getDomainMapping(request);
 }
 

Parameter

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

Returns

Type	Description
DomainMapping

getDomainMappingCallable()

public final UnaryCallable<GetDomainMappingRequest,DomainMapping> getDomainMappingCallable()

Gets the specified domain mapping.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DomainMappingsClient domainMappingsClient = DomainMappingsClient.create()) {
   GetDomainMappingRequest request =
       GetDomainMappingRequest.newBuilder().setName("name3373707").build();
   ApiFuture<DomainMapping> future =
       domainMappingsClient.getDomainMappingCallable().futureCall(request);
   // Do something.
   DomainMapping response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetDomainMappingRequest,DomainMapping>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns

Type	Description
OperationsClient

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns

Type	Description
OperationsClient

getSettings()

public final DomainMappingsSettings getSettings()

Returns

Type	Description
DomainMappingsSettings

getStub()

public DomainMappingsStub getStub()

Returns

Type	Description
DomainMappingsStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listDomainMappings(ListDomainMappingsRequest request)

public final DomainMappingsClient.ListDomainMappingsPagedResponse listDomainMappings(ListDomainMappingsRequest request)

Lists the domain mappings on an application.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DomainMappingsClient domainMappingsClient = DomainMappingsClient.create()) {
   ListDomainMappingsRequest request =
       ListDomainMappingsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (DomainMapping element : domainMappingsClient.listDomainMappings(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

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

Returns

Type	Description
DomainMappingsClient.ListDomainMappingsPagedResponse

listDomainMappingsCallable()

public final UnaryCallable<ListDomainMappingsRequest,ListDomainMappingsResponse> listDomainMappingsCallable()

Lists the domain mappings on an application.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DomainMappingsClient domainMappingsClient = DomainMappingsClient.create()) {
   ListDomainMappingsRequest request =
       ListDomainMappingsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListDomainMappingsResponse response =
         domainMappingsClient.listDomainMappingsCallable().call(request);
     for (DomainMapping element : response.getDomainMappingsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListDomainMappingsRequest,ListDomainMappingsResponse>

listDomainMappingsPagedCallable()

public final UnaryCallable<ListDomainMappingsRequest,DomainMappingsClient.ListDomainMappingsPagedResponse> listDomainMappingsPagedCallable()

Lists the domain mappings on an application.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DomainMappingsClient domainMappingsClient = DomainMappingsClient.create()) {
   ListDomainMappingsRequest request =
       ListDomainMappingsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<DomainMapping> future =
       domainMappingsClient.listDomainMappingsPagedCallable().futureCall(request);
   // Do something.
   for (DomainMapping element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListDomainMappingsRequest,ListDomainMappingsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateDomainMappingAsync(UpdateDomainMappingRequest request)

public final OperationFuture<DomainMapping,OperationMetadataV1> updateDomainMappingAsync(UpdateDomainMappingRequest request)

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.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DomainMappingsClient domainMappingsClient = DomainMappingsClient.create()) {
   UpdateDomainMappingRequest request =
       UpdateDomainMappingRequest.newBuilder()
           .setName("name3373707")
           .setDomainMapping(DomainMapping.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   DomainMapping response = domainMappingsClient.updateDomainMappingAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<DomainMapping,OperationMetadataV1>

updateDomainMappingCallable()

public final UnaryCallable<UpdateDomainMappingRequest,Operation> updateDomainMappingCallable()

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.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DomainMappingsClient domainMappingsClient = DomainMappingsClient.create()) {
   UpdateDomainMappingRequest request =
       UpdateDomainMappingRequest.newBuilder()
           .setName("name3373707")
           .setDomainMapping(DomainMapping.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       domainMappingsClient.updateDomainMappingCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<UpdateDomainMappingRequest,Operation>

updateDomainMappingOperationCallable()

public final OperationCallable<UpdateDomainMappingRequest,DomainMapping,OperationMetadataV1> updateDomainMappingOperationCallable()

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.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DomainMappingsClient domainMappingsClient = DomainMappingsClient.create()) {
   UpdateDomainMappingRequest request =
       UpdateDomainMappingRequest.newBuilder()
           .setName("name3373707")
           .setDomainMapping(DomainMapping.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<DomainMapping, OperationMetadataV1> future =
       domainMappingsClient.updateDomainMappingOperationCallable().futureCall(request);
   // Do something.
   DomainMapping response = future.get();
 }
 

Returns

Type	Description
OperationCallable<UpdateDomainMappingRequest,DomainMapping,OperationMetadataV1>