Package com.google.appengine.v1

Class DomainMappingsClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, AutoCloseable
    @Generated("by gapic-generator-java")
public class DomainMappingsClient
extends Object
implements com.google.api.gax.core.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.newHttpJsonBuilder().build();
 DomainMappingsClient domainMappingsClient = DomainMappingsClient.create(domainMappingsSettings);

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

    • Constructor Detail

      • DomainMappingsClient

        protected DomainMappingsClient​(DomainMappingsSettings settings)
                        throws IOException
        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.
        Throws:
        IOException

    • Method Detail

      • create

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

      • getOperationsClient

        public final com.google.longrunning.OperationsClient getOperationsClient()
        Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

      • getHttpJsonOperationsClient

        @BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
        Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

      • listDomainMappings

        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);
   }
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listDomainMappingsPagedCallable

        public final com.google.api.gax.rpc.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);
   }
 }

      • listDomainMappingsCallable

        public final com.google.api.gax.rpc.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;
     }
   }
 }

      • getDomainMapping

        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);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getDomainMappingCallable

        public final com.google.api.gax.rpc.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();
 }

      • createDomainMappingAsync

        public final com.google.api.gax.longrunning.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();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createDomainMappingOperationCallable

        public final com.google.api.gax.rpc.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();
 }

      • createDomainMappingCallable

        public final com.google.api.gax.rpc.UnaryCallable<CreateDomainMappingRequest,​com.google.longrunning.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();
 }

      • updateDomainMappingAsync

        public final com.google.api.gax.longrunning.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();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • updateDomainMappingOperationCallable

        public final com.google.api.gax.rpc.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();
 }

      • updateDomainMappingCallable

        public final com.google.api.gax.rpc.UnaryCallable<UpdateDomainMappingRequest,​com.google.longrunning.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();
 }

      • deleteDomainMappingAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteDomainMappingOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<DeleteDomainMappingRequest,​com.google.protobuf.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();
 }

      • deleteDomainMappingCallable

        public final com.google.api.gax.rpc.UnaryCallable<DeleteDomainMappingRequest,​com.google.longrunning.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();
 }

      • shutdown

        public void shutdown()
        Specified by:
        shutdown in interface com.google.api.gax.core.BackgroundResource

      • isShutdown

        public boolean isShutdown()
        Specified by:
        isShutdown in interface com.google.api.gax.core.BackgroundResource

      • isTerminated

        public boolean isTerminated()
        Specified by:
        isTerminated in interface com.google.api.gax.core.BackgroundResource

      • shutdownNow

        public void shutdownNow()
        Specified by:
        shutdownNow in interface com.google.api.gax.core.BackgroundResource