Class EntitySignalsMappingServiceClient (0.13.0)

Service Description: Provides methods for handling EntitySignalsMapping objects.

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 (EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create()) {
   EntitySignalsMappingName name =
       EntitySignalsMappingName.of("[NETWORK_CODE]", "[ENTITY_SIGNALS_MAPPING]");
   EntitySignalsMapping response =
       entitySignalsMappingServiceClient.getEntitySignalsMapping(name);
 }

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

Methods
Method	Description	Method Variants
GetEntitySignalsMapping	API to retrieve a `EntitySignalsMapping` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getEntitySignalsMapping(GetEntitySignalsMappingRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getEntitySignalsMapping(EntitySignalsMappingName name) getEntitySignalsMapping(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getEntitySignalsMappingCallable()
ListEntitySignalsMappings	API to retrieve a list of `EntitySignalsMapping` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listEntitySignalsMappings(ListEntitySignalsMappingsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listEntitySignalsMappings(NetworkName parent) listEntitySignalsMappings(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listEntitySignalsMappingsPagedCallable() listEntitySignalsMappingsCallable()
CreateEntitySignalsMapping	API to create an `EntitySignalsMapping` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createEntitySignalsMapping(CreateEntitySignalsMappingRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createEntitySignalsMapping(NetworkName parent, EntitySignalsMapping entitySignalsMapping) createEntitySignalsMapping(String parent, EntitySignalsMapping entitySignalsMapping) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createEntitySignalsMappingCallable()
UpdateEntitySignalsMapping	API to update an `EntitySignalsMapping` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateEntitySignalsMapping(UpdateEntitySignalsMappingRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateEntitySignalsMapping(EntitySignalsMapping entitySignalsMapping, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateEntitySignalsMappingCallable()
BatchCreateEntitySignalsMappings	API to batch create `EntitySignalsMapping` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. batchCreateEntitySignalsMappings(NetworkName parent, List<CreateEntitySignalsMappingRequest> requests) batchCreateEntitySignalsMappings(String parent, List<CreateEntitySignalsMappingRequest> requests) batchCreateEntitySignalsMappings(BatchCreateEntitySignalsMappingsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. batchCreateEntitySignalsMappingsCallable()
BatchUpdateEntitySignalsMappings	API to batch update `EntitySignalsMapping` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. batchUpdateEntitySignalsMappings(NetworkName parent, List<UpdateEntitySignalsMappingRequest> requests) batchUpdateEntitySignalsMappings(String parent, List<UpdateEntitySignalsMappingRequest> requests) batchUpdateEntitySignalsMappings(BatchUpdateEntitySignalsMappingsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. batchUpdateEntitySignalsMappingsCallable()

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 EntitySignalsMappingServiceSettings 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
 EntitySignalsMappingServiceSettings entitySignalsMappingServiceSettings =
     EntitySignalsMappingServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create(entitySignalsMappingServiceSettings);

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
 EntitySignalsMappingServiceSettings entitySignalsMappingServiceSettings =
     EntitySignalsMappingServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create(entitySignalsMappingServiceSettings);

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

Inheritance

java.lang.Object > EntitySignalsMappingServiceClient

Static Methods

create()

public static final EntitySignalsMappingServiceClient create()

Constructs an instance of EntitySignalsMappingServiceClient with default settings.

Returns
Type	Description
`EntitySignalsMappingServiceClient`

Exceptions
Type	Description
`IOException`

create(EntitySignalsMappingServiceSettings settings)

public static final EntitySignalsMappingServiceClient create(EntitySignalsMappingServiceSettings settings)

Constructs an instance of EntitySignalsMappingServiceClient, 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`	`EntitySignalsMappingServiceSettings`

Returns
Type	Description
`EntitySignalsMappingServiceClient`

Exceptions
Type	Description
`IOException`

create(EntitySignalsMappingServiceStub stub)

public static final EntitySignalsMappingServiceClient create(EntitySignalsMappingServiceStub stub)

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

Parameter
Name	Description
`stub`	`EntitySignalsMappingServiceStub`

Returns
Type	Description
`EntitySignalsMappingServiceClient`

Constructors

EntitySignalsMappingServiceClient(EntitySignalsMappingServiceSettings settings)

protected EntitySignalsMappingServiceClient(EntitySignalsMappingServiceSettings settings)

Constructs an instance of EntitySignalsMappingServiceClient, 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`	`EntitySignalsMappingServiceSettings`

EntitySignalsMappingServiceClient(EntitySignalsMappingServiceStub stub)

protected EntitySignalsMappingServiceClient(EntitySignalsMappingServiceStub stub)

Parameter
Name	Description
`stub`	`EntitySignalsMappingServiceStub`

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`

batchCreateEntitySignalsMappings(BatchCreateEntitySignalsMappingsRequest request)

public final BatchCreateEntitySignalsMappingsResponse batchCreateEntitySignalsMappings(BatchCreateEntitySignalsMappingsRequest request)

API to batch create EntitySignalsMapping objects.

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 (EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create()) {
   BatchCreateEntitySignalsMappingsRequest request =
       BatchCreateEntitySignalsMappingsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllRequests(new ArrayList<CreateEntitySignalsMappingRequest>())
           .build();
   BatchCreateEntitySignalsMappingsResponse response =
       entitySignalsMappingServiceClient.batchCreateEntitySignalsMappings(request);
 }

Parameter
Name	Description
`request`	`BatchCreateEntitySignalsMappingsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BatchCreateEntitySignalsMappingsResponse`

batchCreateEntitySignalsMappings(NetworkName parent, List<CreateEntitySignalsMappingRequest> requests)

public final BatchCreateEntitySignalsMappingsResponse batchCreateEntitySignalsMappings(NetworkName parent, List<CreateEntitySignalsMappingRequest> requests)

API to batch create EntitySignalsMapping objects.

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 (EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   List<CreateEntitySignalsMappingRequest> requests = new ArrayList<>();
   BatchCreateEntitySignalsMappingsResponse response =
       entitySignalsMappingServiceClient.batchCreateEntitySignalsMappings(parent, requests);
 }

Parameters
Name	Description
`parent`	`NetworkName` Required. The parent resource where `EntitySignalsMappings` will be created. Format: `networks/{network_code}` The parent field in the CreateEntitySignalsMappingRequest must match this field.
`requests`	`List<CreateEntitySignalsMappingRequest>` Required. The `EntitySignalsMapping` objects to create. A maximum of 100 objects can be created in a batch.

Returns
Type	Description
`BatchCreateEntitySignalsMappingsResponse`

batchCreateEntitySignalsMappings(String parent, List<CreateEntitySignalsMappingRequest> requests)

public final BatchCreateEntitySignalsMappingsResponse batchCreateEntitySignalsMappings(String parent, List<CreateEntitySignalsMappingRequest> requests)

API to batch create EntitySignalsMapping objects.

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 (EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   List<CreateEntitySignalsMappingRequest> requests = new ArrayList<>();
   BatchCreateEntitySignalsMappingsResponse response =
       entitySignalsMappingServiceClient.batchCreateEntitySignalsMappings(parent, requests);
 }

Parameters
Name	Description
`parent`	`String` Required. The parent resource where `EntitySignalsMappings` will be created. Format: `networks/{network_code}` The parent field in the CreateEntitySignalsMappingRequest must match this field.
`requests`	`List<CreateEntitySignalsMappingRequest>` Required. The `EntitySignalsMapping` objects to create. A maximum of 100 objects can be created in a batch.

Returns
Type	Description
`BatchCreateEntitySignalsMappingsResponse`

batchCreateEntitySignalsMappingsCallable()

public final UnaryCallable<BatchCreateEntitySignalsMappingsRequest,BatchCreateEntitySignalsMappingsResponse> batchCreateEntitySignalsMappingsCallable()

API to batch create EntitySignalsMapping objects.

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 (EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create()) {
   BatchCreateEntitySignalsMappingsRequest request =
       BatchCreateEntitySignalsMappingsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllRequests(new ArrayList<CreateEntitySignalsMappingRequest>())
           .build();
   ApiFuture<BatchCreateEntitySignalsMappingsResponse> future =
       entitySignalsMappingServiceClient
           .batchCreateEntitySignalsMappingsCallable()
           .futureCall(request);
   // Do something.
   BatchCreateEntitySignalsMappingsResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<BatchCreateEntitySignalsMappingsRequest,BatchCreateEntitySignalsMappingsResponse>`

batchUpdateEntitySignalsMappings(BatchUpdateEntitySignalsMappingsRequest request)

public final BatchUpdateEntitySignalsMappingsResponse batchUpdateEntitySignalsMappings(BatchUpdateEntitySignalsMappingsRequest request)

API to batch update EntitySignalsMapping objects.

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 (EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create()) {
   BatchUpdateEntitySignalsMappingsRequest request =
       BatchUpdateEntitySignalsMappingsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllRequests(new ArrayList<UpdateEntitySignalsMappingRequest>())
           .build();
   BatchUpdateEntitySignalsMappingsResponse response =
       entitySignalsMappingServiceClient.batchUpdateEntitySignalsMappings(request);
 }

Parameter
Name	Description
`request`	`BatchUpdateEntitySignalsMappingsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BatchUpdateEntitySignalsMappingsResponse`

batchUpdateEntitySignalsMappings(NetworkName parent, List<UpdateEntitySignalsMappingRequest> requests)

public final BatchUpdateEntitySignalsMappingsResponse batchUpdateEntitySignalsMappings(NetworkName parent, List<UpdateEntitySignalsMappingRequest> requests)

API to batch update EntitySignalsMapping objects.

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 (EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   List<UpdateEntitySignalsMappingRequest> requests = new ArrayList<>();
   BatchUpdateEntitySignalsMappingsResponse response =
       entitySignalsMappingServiceClient.batchUpdateEntitySignalsMappings(parent, requests);
 }

Parameters
Name	Description
`parent`	`NetworkName` Required. The parent resource where `EntitySignalsMappings` will be updated. Format: `networks/{network_code}` The parent field in the UpdateEntitySignalsMappingRequest must match this field.
`requests`	`List<UpdateEntitySignalsMappingRequest>` Required. The `EntitySignalsMapping` objects to update. A maximum of 100 objects can be updated in a batch.

Returns
Type	Description
`BatchUpdateEntitySignalsMappingsResponse`

batchUpdateEntitySignalsMappings(String parent, List<UpdateEntitySignalsMappingRequest> requests)

public final BatchUpdateEntitySignalsMappingsResponse batchUpdateEntitySignalsMappings(String parent, List<UpdateEntitySignalsMappingRequest> requests)

API to batch update EntitySignalsMapping objects.

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 (EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   List<UpdateEntitySignalsMappingRequest> requests = new ArrayList<>();
   BatchUpdateEntitySignalsMappingsResponse response =
       entitySignalsMappingServiceClient.batchUpdateEntitySignalsMappings(parent, requests);
 }

Parameters
Name	Description
`parent`	`String` Required. The parent resource where `EntitySignalsMappings` will be updated. Format: `networks/{network_code}` The parent field in the UpdateEntitySignalsMappingRequest must match this field.
`requests`	`List<UpdateEntitySignalsMappingRequest>` Required. The `EntitySignalsMapping` objects to update. A maximum of 100 objects can be updated in a batch.

Returns
Type	Description
`BatchUpdateEntitySignalsMappingsResponse`

batchUpdateEntitySignalsMappingsCallable()

public final UnaryCallable<BatchUpdateEntitySignalsMappingsRequest,BatchUpdateEntitySignalsMappingsResponse> batchUpdateEntitySignalsMappingsCallable()

API to batch update EntitySignalsMapping objects.

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 (EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create()) {
   BatchUpdateEntitySignalsMappingsRequest request =
       BatchUpdateEntitySignalsMappingsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllRequests(new ArrayList<UpdateEntitySignalsMappingRequest>())
           .build();
   ApiFuture<BatchUpdateEntitySignalsMappingsResponse> future =
       entitySignalsMappingServiceClient
           .batchUpdateEntitySignalsMappingsCallable()
           .futureCall(request);
   // Do something.
   BatchUpdateEntitySignalsMappingsResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<BatchUpdateEntitySignalsMappingsRequest,BatchUpdateEntitySignalsMappingsResponse>`

close()

public final void close()

createEntitySignalsMapping(CreateEntitySignalsMappingRequest request)

public final EntitySignalsMapping createEntitySignalsMapping(CreateEntitySignalsMappingRequest request)

API to create an EntitySignalsMapping object.

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 (EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create()) {
   CreateEntitySignalsMappingRequest request =
       CreateEntitySignalsMappingRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setEntitySignalsMapping(EntitySignalsMapping.newBuilder().build())
           .build();
   EntitySignalsMapping response =
       entitySignalsMappingServiceClient.createEntitySignalsMapping(request);
 }

Parameter
Name	Description
`request`	`CreateEntitySignalsMappingRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`EntitySignalsMapping`

createEntitySignalsMapping(NetworkName parent, EntitySignalsMapping entitySignalsMapping)

public final EntitySignalsMapping createEntitySignalsMapping(NetworkName parent, EntitySignalsMapping entitySignalsMapping)

API to create an EntitySignalsMapping object.

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 (EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   EntitySignalsMapping entitySignalsMapping = EntitySignalsMapping.newBuilder().build();
   EntitySignalsMapping response =
       entitySignalsMappingServiceClient.createEntitySignalsMapping(
           parent, entitySignalsMapping);
 }

Parameters
Name	Description
`parent`	`NetworkName` Required. The parent resource where this EntitySignalsMapping will be created. Format: `networks/{network_code}`
`entitySignalsMapping`	`EntitySignalsMapping` Required. The EntitySignalsMapping object to create.

Returns
Type	Description
`EntitySignalsMapping`

createEntitySignalsMapping(String parent, EntitySignalsMapping entitySignalsMapping)

public final EntitySignalsMapping createEntitySignalsMapping(String parent, EntitySignalsMapping entitySignalsMapping)

API to create an EntitySignalsMapping object.

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 (EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   EntitySignalsMapping entitySignalsMapping = EntitySignalsMapping.newBuilder().build();
   EntitySignalsMapping response =
       entitySignalsMappingServiceClient.createEntitySignalsMapping(
           parent, entitySignalsMapping);
 }

Parameters
Name	Description
`parent`	`String` Required. The parent resource where this EntitySignalsMapping will be created. Format: `networks/{network_code}`
`entitySignalsMapping`	`EntitySignalsMapping` Required. The EntitySignalsMapping object to create.

Returns
Type	Description
`EntitySignalsMapping`

createEntitySignalsMappingCallable()

public final UnaryCallable<CreateEntitySignalsMappingRequest,EntitySignalsMapping> createEntitySignalsMappingCallable()

API to create an EntitySignalsMapping object.

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 (EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create()) {
   CreateEntitySignalsMappingRequest request =
       CreateEntitySignalsMappingRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setEntitySignalsMapping(EntitySignalsMapping.newBuilder().build())
           .build();
   ApiFuture<EntitySignalsMapping> future =
       entitySignalsMappingServiceClient
           .createEntitySignalsMappingCallable()
           .futureCall(request);
   // Do something.
   EntitySignalsMapping response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateEntitySignalsMappingRequest,EntitySignalsMapping>`

getEntitySignalsMapping(EntitySignalsMappingName name)

public final EntitySignalsMapping getEntitySignalsMapping(EntitySignalsMappingName name)

API to retrieve a EntitySignalsMapping object.

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 (EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create()) {
   EntitySignalsMappingName name =
       EntitySignalsMappingName.of("[NETWORK_CODE]", "[ENTITY_SIGNALS_MAPPING]");
   EntitySignalsMapping response =
       entitySignalsMappingServiceClient.getEntitySignalsMapping(name);
 }

Parameter
Name	Description
`name`	`EntitySignalsMappingName` Required. The resource name of the EntitySignalsMapping. Format: `networks/{network_code}/entitySignalsMappings/{entity_signals_mapping_id}`

Returns
Type	Description
`EntitySignalsMapping`

getEntitySignalsMapping(GetEntitySignalsMappingRequest request)

public final EntitySignalsMapping getEntitySignalsMapping(GetEntitySignalsMappingRequest request)

API to retrieve a EntitySignalsMapping object.

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 (EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create()) {
   GetEntitySignalsMappingRequest request =
       GetEntitySignalsMappingRequest.newBuilder()
           .setName(
               EntitySignalsMappingName.of("[NETWORK_CODE]", "[ENTITY_SIGNALS_MAPPING]")
                   .toString())
           .build();
   EntitySignalsMapping response =
       entitySignalsMappingServiceClient.getEntitySignalsMapping(request);
 }

Parameter
Name	Description
`request`	`GetEntitySignalsMappingRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`EntitySignalsMapping`

getEntitySignalsMapping(String name)

public final EntitySignalsMapping getEntitySignalsMapping(String name)

API to retrieve a EntitySignalsMapping object.

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 (EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create()) {
   String name =
       EntitySignalsMappingName.of("[NETWORK_CODE]", "[ENTITY_SIGNALS_MAPPING]").toString();
   EntitySignalsMapping response =
       entitySignalsMappingServiceClient.getEntitySignalsMapping(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the EntitySignalsMapping. Format: `networks/{network_code}/entitySignalsMappings/{entity_signals_mapping_id}`

Returns
Type	Description
`EntitySignalsMapping`

getEntitySignalsMappingCallable()

public final UnaryCallable<GetEntitySignalsMappingRequest,EntitySignalsMapping> getEntitySignalsMappingCallable()

API to retrieve a EntitySignalsMapping object.

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 (EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create()) {
   GetEntitySignalsMappingRequest request =
       GetEntitySignalsMappingRequest.newBuilder()
           .setName(
               EntitySignalsMappingName.of("[NETWORK_CODE]", "[ENTITY_SIGNALS_MAPPING]")
                   .toString())
           .build();
   ApiFuture<EntitySignalsMapping> future =
       entitySignalsMappingServiceClient.getEntitySignalsMappingCallable().futureCall(request);
   // Do something.
   EntitySignalsMapping response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetEntitySignalsMappingRequest,EntitySignalsMapping>`

getSettings()

public final EntitySignalsMappingServiceSettings getSettings()

Returns
Type	Description
`EntitySignalsMappingServiceSettings`

getStub()

public EntitySignalsMappingServiceStub getStub()

Returns
Type	Description
`EntitySignalsMappingServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listEntitySignalsMappings(ListEntitySignalsMappingsRequest request)

public final EntitySignalsMappingServiceClient.ListEntitySignalsMappingsPagedResponse listEntitySignalsMappings(ListEntitySignalsMappingsRequest request)

API to retrieve a list of EntitySignalsMapping objects.

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 (EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create()) {
   ListEntitySignalsMappingsRequest request =
       ListEntitySignalsMappingsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   for (EntitySignalsMapping element :
       entitySignalsMappingServiceClient.listEntitySignalsMappings(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListEntitySignalsMappingsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`EntitySignalsMappingServiceClient.ListEntitySignalsMappingsPagedResponse`

listEntitySignalsMappings(NetworkName parent)

public final EntitySignalsMappingServiceClient.ListEntitySignalsMappingsPagedResponse listEntitySignalsMappings(NetworkName parent)

API to retrieve a list of EntitySignalsMapping objects.

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 (EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   for (EntitySignalsMapping element :
       entitySignalsMappingServiceClient.listEntitySignalsMappings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`NetworkName` Required. The parent, which owns this collection of EntitySignalsMappings. Format: `networks/{network_code}`

Returns
Type	Description
`EntitySignalsMappingServiceClient.ListEntitySignalsMappingsPagedResponse`

listEntitySignalsMappings(String parent)

public final EntitySignalsMappingServiceClient.ListEntitySignalsMappingsPagedResponse listEntitySignalsMappings(String parent)

API to retrieve a list of EntitySignalsMapping objects.

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 (EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   for (EntitySignalsMapping element :
       entitySignalsMappingServiceClient.listEntitySignalsMappings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent, which owns this collection of EntitySignalsMappings. Format: `networks/{network_code}`

Returns
Type	Description
`EntitySignalsMappingServiceClient.ListEntitySignalsMappingsPagedResponse`

listEntitySignalsMappingsCallable()

public final UnaryCallable<ListEntitySignalsMappingsRequest,ListEntitySignalsMappingsResponse> listEntitySignalsMappingsCallable()

API to retrieve a list of EntitySignalsMapping objects.

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 (EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create()) {
   ListEntitySignalsMappingsRequest request =
       ListEntitySignalsMappingsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   while (true) {
     ListEntitySignalsMappingsResponse response =
         entitySignalsMappingServiceClient.listEntitySignalsMappingsCallable().call(request);
     for (EntitySignalsMapping element : response.getEntitySignalsMappingsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListEntitySignalsMappingsRequest,ListEntitySignalsMappingsResponse>`

listEntitySignalsMappingsPagedCallable()

public final UnaryCallable<ListEntitySignalsMappingsRequest,EntitySignalsMappingServiceClient.ListEntitySignalsMappingsPagedResponse> listEntitySignalsMappingsPagedCallable()

API to retrieve a list of EntitySignalsMapping objects.

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 (EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create()) {
   ListEntitySignalsMappingsRequest request =
       ListEntitySignalsMappingsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   ApiFuture<EntitySignalsMapping> future =
       entitySignalsMappingServiceClient
           .listEntitySignalsMappingsPagedCallable()
           .futureCall(request);
   // Do something.
   for (EntitySignalsMapping element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListEntitySignalsMappingsRequest,ListEntitySignalsMappingsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateEntitySignalsMapping(EntitySignalsMapping entitySignalsMapping, FieldMask updateMask)

public final EntitySignalsMapping updateEntitySignalsMapping(EntitySignalsMapping entitySignalsMapping, FieldMask updateMask)

API to update an EntitySignalsMapping object.

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 (EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create()) {
   EntitySignalsMapping entitySignalsMapping = EntitySignalsMapping.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   EntitySignalsMapping response =
       entitySignalsMappingServiceClient.updateEntitySignalsMapping(
           entitySignalsMapping, updateMask);
 }

Parameters

Name Description

entitySignalsMapping

EntitySignalsMapping

Required. The EntitySignalsMapping to update.

The EntitySignalsMapping's name is used to identify the EntitySignalsMapping to update. Format: networks/{network_code}/entitySignalsMappings/{entity_signals_mapping}

updateMask

FieldMask

Required. The list of fields to update.

Returns
Type	Description
`EntitySignalsMapping`

updateEntitySignalsMapping(UpdateEntitySignalsMappingRequest request)

public final EntitySignalsMapping updateEntitySignalsMapping(UpdateEntitySignalsMappingRequest request)

API to update an EntitySignalsMapping object.

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 (EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create()) {
   UpdateEntitySignalsMappingRequest request =
       UpdateEntitySignalsMappingRequest.newBuilder()
           .setEntitySignalsMapping(EntitySignalsMapping.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   EntitySignalsMapping response =
       entitySignalsMappingServiceClient.updateEntitySignalsMapping(request);
 }

Parameter
Name	Description
`request`	`UpdateEntitySignalsMappingRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`EntitySignalsMapping`

updateEntitySignalsMappingCallable()

public final UnaryCallable<UpdateEntitySignalsMappingRequest,EntitySignalsMapping> updateEntitySignalsMappingCallable()

API to update an EntitySignalsMapping object.

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 (EntitySignalsMappingServiceClient entitySignalsMappingServiceClient =
     EntitySignalsMappingServiceClient.create()) {
   UpdateEntitySignalsMappingRequest request =
       UpdateEntitySignalsMappingRequest.newBuilder()
           .setEntitySignalsMapping(EntitySignalsMapping.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<EntitySignalsMapping> future =
       entitySignalsMappingServiceClient
           .updateEntitySignalsMappingCallable()
           .futureCall(request);
   // Do something.
   EntitySignalsMapping response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateEntitySignalsMappingRequest,EntitySignalsMapping>`