Class ContactServiceClient (0.54.0)

Service Description: Provides methods for handling Contact 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 (ContactServiceClient contactServiceClient = ContactServiceClient.create()) {
   ContactName name = ContactName.of("[NETWORK_CODE]", "[CONTACT]");
   Contact response = contactServiceClient.getContact(name);
 }

Note: close() needs to be called on the ContactServiceClient 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
GetContact	Retrieves a `Contact` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getContact(GetContactRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getContact(ContactName name) getContact(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. getContactCallable()
ListContacts	Lists `Contact` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listContacts(ListContactsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listContacts(NetworkName parent) listContacts(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. listContactsPagedCallable() listContactsCallable()
CreateContact	Creates a `Contact` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createContact(CreateContactRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createContact(NetworkName parent, Contact contact) createContact(String parent, Contact contact) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createContactCallable()
BatchCreateContacts	Creates `Contact` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. batchCreateContacts(NetworkName parent, List<CreateContactRequest> requests) batchCreateContacts(String parent, List<CreateContactRequest> requests) batchCreateContacts(BatchCreateContactsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. batchCreateContactsCallable()
UpdateContact	Updates a `Contact` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateContact(UpdateContactRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateContact(Contact contact, 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. updateContactCallable()
BatchUpdateContacts	Batch updates `Contact` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. batchUpdateContacts(NetworkName parent, List<UpdateContactRequest> requests) batchUpdateContacts(String parent, List<UpdateContactRequest> requests) batchUpdateContacts(BatchUpdateContactsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. batchUpdateContactsCallable()

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 ContactServiceSettings 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
 ContactServiceSettings contactServiceSettings =
     ContactServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ContactServiceClient contactServiceClient = ContactServiceClient.create(contactServiceSettings);

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
 ContactServiceSettings contactServiceSettings =
     ContactServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ContactServiceClient contactServiceClient = ContactServiceClient.create(contactServiceSettings);

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

Inheritance

java.lang.Object > ContactServiceClient

Static Methods

create()

public static final ContactServiceClient create()

Constructs an instance of ContactServiceClient with default settings.

Returns
Type	Description
`ContactServiceClient`

Exceptions
Type	Description
`IOException`

create(ContactServiceSettings settings)

public static final ContactServiceClient create(ContactServiceSettings settings)

Constructs an instance of ContactServiceClient, 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`	`ContactServiceSettings`

Returns
Type	Description
`ContactServiceClient`

Exceptions
Type	Description
`IOException`

create(ContactServiceStub stub)

public static final ContactServiceClient create(ContactServiceStub stub)

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

Parameter
Name	Description
`stub`	`ContactServiceStub`

Returns
Type	Description
`ContactServiceClient`

Constructors

ContactServiceClient(ContactServiceSettings settings)

protected ContactServiceClient(ContactServiceSettings settings)

Constructs an instance of ContactServiceClient, 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`	`ContactServiceSettings`

ContactServiceClient(ContactServiceStub stub)

protected ContactServiceClient(ContactServiceStub stub)

Parameter
Name	Description
`stub`	`ContactServiceStub`

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`

batchCreateContacts(@Nullable NetworkName parent, List<CreateContactRequest> requests)

public final BatchCreateContactsResponse batchCreateContacts(@Nullable NetworkName parent, List<CreateContactRequest> requests)

Creates Contact 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 (ContactServiceClient contactServiceClient = ContactServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   List<CreateContactRequest> requests = new ArrayList<>();
   BatchCreateContactsResponse response =
       contactServiceClient.batchCreateContacts(parent, requests);
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkName` Required. The parent resource where `Contacts` will be created. Format: `networks/{network_code}` The parent field in the CreateContactRequest must match this field.
`requests`	`List<CreateContactRequest>` Required. The `Contact` objects to create. A maximum of 100 objects can be created in a batch.

Returns
Type	Description
`BatchCreateContactsResponse`

batchCreateContacts(BatchCreateContactsRequest request)

public final BatchCreateContactsResponse batchCreateContacts(BatchCreateContactsRequest request)

Creates Contact 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 (ContactServiceClient contactServiceClient = ContactServiceClient.create()) {
   BatchCreateContactsRequest request =
       BatchCreateContactsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllRequests(new ArrayList<CreateContactRequest>())
           .build();
   BatchCreateContactsResponse response = contactServiceClient.batchCreateContacts(request);
 }

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

Returns
Type	Description
`BatchCreateContactsResponse`

batchCreateContacts(String parent, List<CreateContactRequest> requests)

public final BatchCreateContactsResponse batchCreateContacts(String parent, List<CreateContactRequest> requests)

Creates Contact 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 (ContactServiceClient contactServiceClient = ContactServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   List<CreateContactRequest> requests = new ArrayList<>();
   BatchCreateContactsResponse response =
       contactServiceClient.batchCreateContacts(parent, requests);
 }

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

Returns
Type	Description
`BatchCreateContactsResponse`

batchCreateContactsCallable()

public final UnaryCallable<BatchCreateContactsRequest,BatchCreateContactsResponse> batchCreateContactsCallable()

Creates Contact 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 (ContactServiceClient contactServiceClient = ContactServiceClient.create()) {
   BatchCreateContactsRequest request =
       BatchCreateContactsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllRequests(new ArrayList<CreateContactRequest>())
           .build();
   ApiFuture<BatchCreateContactsResponse> future =
       contactServiceClient.batchCreateContactsCallable().futureCall(request);
   // Do something.
   BatchCreateContactsResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<BatchCreateContactsRequest,BatchCreateContactsResponse>`

batchUpdateContacts(@Nullable NetworkName parent, List<UpdateContactRequest> requests)

public final BatchUpdateContactsResponse batchUpdateContacts(@Nullable NetworkName parent, List<UpdateContactRequest> requests)

Batch updates Contact 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 (ContactServiceClient contactServiceClient = ContactServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   List<UpdateContactRequest> requests = new ArrayList<>();
   BatchUpdateContactsResponse response =
       contactServiceClient.batchUpdateContacts(parent, requests);
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkName` Required. The parent resource where `Contacts` will be updated. Format: `networks/{network_code}` The parent field in the UpdateContactRequest must match this field.
`requests`	`List<UpdateContactRequest>` Required. The `Contact` objects to update. A maximum of 100 objects can be updated in a batch.

Returns
Type	Description
`BatchUpdateContactsResponse`

batchUpdateContacts(BatchUpdateContactsRequest request)

public final BatchUpdateContactsResponse batchUpdateContacts(BatchUpdateContactsRequest request)

Batch updates Contact 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 (ContactServiceClient contactServiceClient = ContactServiceClient.create()) {
   BatchUpdateContactsRequest request =
       BatchUpdateContactsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllRequests(new ArrayList<UpdateContactRequest>())
           .build();
   BatchUpdateContactsResponse response = contactServiceClient.batchUpdateContacts(request);
 }

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

Returns
Type	Description
`BatchUpdateContactsResponse`

batchUpdateContacts(String parent, List<UpdateContactRequest> requests)

public final BatchUpdateContactsResponse batchUpdateContacts(String parent, List<UpdateContactRequest> requests)

Batch updates Contact 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 (ContactServiceClient contactServiceClient = ContactServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   List<UpdateContactRequest> requests = new ArrayList<>();
   BatchUpdateContactsResponse response =
       contactServiceClient.batchUpdateContacts(parent, requests);
 }

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

Returns
Type	Description
`BatchUpdateContactsResponse`

batchUpdateContactsCallable()

public final UnaryCallable<BatchUpdateContactsRequest,BatchUpdateContactsResponse> batchUpdateContactsCallable()

Batch updates Contact 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 (ContactServiceClient contactServiceClient = ContactServiceClient.create()) {
   BatchUpdateContactsRequest request =
       BatchUpdateContactsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllRequests(new ArrayList<UpdateContactRequest>())
           .build();
   ApiFuture<BatchUpdateContactsResponse> future =
       contactServiceClient.batchUpdateContactsCallable().futureCall(request);
   // Do something.
   BatchUpdateContactsResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<BatchUpdateContactsRequest,BatchUpdateContactsResponse>`

close()

public final void close()

createContact(@Nullable NetworkName parent, Contact contact)

public final Contact createContact(@Nullable NetworkName parent, Contact contact)

Creates a Contact 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 (ContactServiceClient contactServiceClient = ContactServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   Contact contact = Contact.newBuilder().build();
   Contact response = contactServiceClient.createContact(parent, contact);
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkName` Required. The parent resource where this `Contact` will be created. Format: `networks/{network_code}`
`contact`	`Contact` Required. The `Contact` to create.

Returns
Type	Description
`Contact`

createContact(CreateContactRequest request)

public final Contact createContact(CreateContactRequest request)

Creates a Contact 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 (ContactServiceClient contactServiceClient = ContactServiceClient.create()) {
   CreateContactRequest request =
       CreateContactRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setContact(Contact.newBuilder().build())
           .build();
   Contact response = contactServiceClient.createContact(request);
 }

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

Returns
Type	Description
`Contact`

createContact(String parent, Contact contact)

public final Contact createContact(String parent, Contact contact)

Creates a Contact 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 (ContactServiceClient contactServiceClient = ContactServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   Contact contact = Contact.newBuilder().build();
   Contact response = contactServiceClient.createContact(parent, contact);
 }

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

Returns
Type	Description
`Contact`

createContactCallable()

public final UnaryCallable<CreateContactRequest,Contact> createContactCallable()

Creates a Contact 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 (ContactServiceClient contactServiceClient = ContactServiceClient.create()) {
   CreateContactRequest request =
       CreateContactRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setContact(Contact.newBuilder().build())
           .build();
   ApiFuture<Contact> future = contactServiceClient.createContactCallable().futureCall(request);
   // Do something.
   Contact response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateContactRequest,Contact>`

getContact(@Nullable ContactName name)

public final Contact getContact(@Nullable ContactName name)

Retrieves a Contact 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 (ContactServiceClient contactServiceClient = ContactServiceClient.create()) {
   ContactName name = ContactName.of("[NETWORK_CODE]", "[CONTACT]");
   Contact response = contactServiceClient.getContact(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.ContactName` Required. The resource name of the Contact. Format: `networks/{network_code}/contacts/{contact_id}`

Returns
Type	Description
`Contact`

getContact(GetContactRequest request)

public final Contact getContact(GetContactRequest request)

Retrieves a Contact 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 (ContactServiceClient contactServiceClient = ContactServiceClient.create()) {
   GetContactRequest request =
       GetContactRequest.newBuilder()
           .setName(ContactName.of("[NETWORK_CODE]", "[CONTACT]").toString())
           .build();
   Contact response = contactServiceClient.getContact(request);
 }

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

Returns
Type	Description
`Contact`

getContact(String name)

public final Contact getContact(String name)

Retrieves a Contact 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 (ContactServiceClient contactServiceClient = ContactServiceClient.create()) {
   String name = ContactName.of("[NETWORK_CODE]", "[CONTACT]").toString();
   Contact response = contactServiceClient.getContact(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the Contact. Format: `networks/{network_code}/contacts/{contact_id}`

Returns
Type	Description
`Contact`

getContactCallable()

public final UnaryCallable<GetContactRequest,Contact> getContactCallable()

Retrieves a Contact 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 (ContactServiceClient contactServiceClient = ContactServiceClient.create()) {
   GetContactRequest request =
       GetContactRequest.newBuilder()
           .setName(ContactName.of("[NETWORK_CODE]", "[CONTACT]").toString())
           .build();
   ApiFuture<Contact> future = contactServiceClient.getContactCallable().futureCall(request);
   // Do something.
   Contact response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetContactRequest,Contact>`

getSettings()

public final @Nullable ContactServiceSettings getSettings()

Returns
Type	Description
`@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.ContactServiceSettings`

getStub()

public ContactServiceStub getStub()

Returns
Type	Description
`ContactServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listContacts(@Nullable NetworkName parent)

public final ContactServiceClient.ListContactsPagedResponse listContacts(@Nullable NetworkName parent)

Lists Contact 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 (ContactServiceClient contactServiceClient = ContactServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   for (Contact element : contactServiceClient.listContacts(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkName` Required. The parent, which owns this collection of Contacts. Format: `networks/{network_code}`

Returns
Type	Description
`ContactServiceClient.ListContactsPagedResponse`

listContacts(ListContactsRequest request)

public final ContactServiceClient.ListContactsPagedResponse listContacts(ListContactsRequest request)

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

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

Returns
Type	Description
`ContactServiceClient.ListContactsPagedResponse`

listContacts(String parent)

public final ContactServiceClient.ListContactsPagedResponse listContacts(String parent)

Lists Contact 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 (ContactServiceClient contactServiceClient = ContactServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   for (Contact element : contactServiceClient.listContacts(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

Returns
Type	Description
`ContactServiceClient.ListContactsPagedResponse`

listContactsCallable()

public final UnaryCallable<ListContactsRequest,ListContactsResponse> listContactsCallable()

Lists Contact 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 (ContactServiceClient contactServiceClient = ContactServiceClient.create()) {
   ListContactsRequest request =
       ListContactsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   while (true) {
     ListContactsResponse response = contactServiceClient.listContactsCallable().call(request);
     for (Contact element : response.getContactsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListContactsRequest,ListContactsResponse>`

listContactsPagedCallable()

public final UnaryCallable<ListContactsRequest,ContactServiceClient.ListContactsPagedResponse> listContactsPagedCallable()

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

Returns
Type	Description
`UnaryCallable<ListContactsRequest,ListContactsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateContact(Contact contact, FieldMask updateMask)

public final Contact updateContact(Contact contact, FieldMask updateMask)

Updates a Contact 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 (ContactServiceClient contactServiceClient = ContactServiceClient.create()) {
   Contact contact = Contact.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Contact response = contactServiceClient.updateContact(contact, updateMask);
 }

Parameters

Name Description

contact

Contact

Required. The Contact to update.

The Contact's name is used to identify the Contact to update.

updateMask

FieldMask

Optional. The list of fields to update.

Returns
Type	Description
`Contact`

updateContact(UpdateContactRequest request)

public final Contact updateContact(UpdateContactRequest request)

Updates a Contact 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 (ContactServiceClient contactServiceClient = ContactServiceClient.create()) {
   UpdateContactRequest request =
       UpdateContactRequest.newBuilder()
           .setContact(Contact.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Contact response = contactServiceClient.updateContact(request);
 }

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

Returns
Type	Description
`Contact`

updateContactCallable()

public final UnaryCallable<UpdateContactRequest,Contact> updateContactCallable()

Updates a Contact 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 (ContactServiceClient contactServiceClient = ContactServiceClient.create()) {
   UpdateContactRequest request =
       UpdateContactRequest.newBuilder()
           .setContact(Contact.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Contact> future = contactServiceClient.updateContactCallable().futureCall(request);
   // Do something.
   Contact response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateContactRequest,Contact>`

Class ContactServiceClient (0.54.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Static Methods

create()

create(ContactServiceSettings settings)

create(ContactServiceStub stub)

Constructors

ContactServiceClient(ContactServiceSettings settings)

ContactServiceClient(ContactServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

batchCreateContacts(@Nullable NetworkName parent, List<CreateContactRequest> requests)

batchCreateContacts(BatchCreateContactsRequest request)

batchCreateContacts(String parent, List<CreateContactRequest> requests)

batchCreateContactsCallable()

batchUpdateContacts(@Nullable NetworkName parent, List<UpdateContactRequest> requests)

batchUpdateContacts(BatchUpdateContactsRequest request)

batchUpdateContacts(String parent, List<UpdateContactRequest> requests)

batchUpdateContactsCallable()

close()

createContact(@Nullable NetworkName parent, Contact contact)

createContact(CreateContactRequest request)

createContact(String parent, Contact contact)

createContactCallable()

getContact(@Nullable ContactName name)

getContact(GetContactRequest request)

getContact(String name)

getContactCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

listContacts(@Nullable NetworkName parent)

listContacts(ListContactsRequest request)

listContacts(String parent)

listContactsCallable()

listContactsPagedCallable()

shutdown()

shutdownNow()

updateContact(Contact contact, FieldMask updateMask)

updateContact(UpdateContactRequest request)

updateContactCallable()

Class ContactServiceClient (0.54.0)