Class ReferenceListServiceClient (0.1.0)

Service Description: ReferenceListService provides an interface for managing reference lists.

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 (ReferenceListServiceClient referenceListServiceClient =
     ReferenceListServiceClient.create()) {
   ReferenceListName name =
       ReferenceListName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[REFERENCE_LIST]");
   ReferenceList response = referenceListServiceClient.getReferenceList(name);
 }

Note: close() needs to be called on the ReferenceListServiceClient 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
GetReferenceList	Gets a single reference list.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getReferenceList(GetReferenceListRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getReferenceList(ReferenceListName name) getReferenceList(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. getReferenceListCallable()
ListReferenceLists	Lists a collection of reference lists.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listReferenceLists(ListReferenceListsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listReferenceLists(InstanceName parent) listReferenceLists(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. listReferenceListsPagedCallable() listReferenceListsCallable()
CreateReferenceList	Creates a new reference list.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createReferenceList(CreateReferenceListRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createReferenceList(InstanceName parent, ReferenceList referenceList, String referenceListId) createReferenceList(String parent, ReferenceList referenceList, String referenceListId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createReferenceListCallable()
UpdateReferenceList	Updates an existing reference list.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateReferenceList(UpdateReferenceListRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateReferenceList(ReferenceList referenceList, 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. updateReferenceListCallable()

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 ReferenceListServiceSettings 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
 ReferenceListServiceSettings referenceListServiceSettings =
     ReferenceListServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ReferenceListServiceClient referenceListServiceClient =
     ReferenceListServiceClient.create(referenceListServiceSettings);

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
 ReferenceListServiceSettings referenceListServiceSettings =
     ReferenceListServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ReferenceListServiceClient referenceListServiceClient =
     ReferenceListServiceClient.create(referenceListServiceSettings);

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
 ReferenceListServiceSettings referenceListServiceSettings =
     ReferenceListServiceSettings.newHttpJsonBuilder().build();
 ReferenceListServiceClient referenceListServiceClient =
     ReferenceListServiceClient.create(referenceListServiceSettings);

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

Inheritance

java.lang.Object > ReferenceListServiceClient

Static Methods

create()

public static final ReferenceListServiceClient create()

Constructs an instance of ReferenceListServiceClient with default settings.

Returns
Type	Description
`ReferenceListServiceClient`

Exceptions
Type	Description
`IOException`

create(ReferenceListServiceSettings settings)

public static final ReferenceListServiceClient create(ReferenceListServiceSettings settings)

Constructs an instance of ReferenceListServiceClient, 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`	`ReferenceListServiceSettings`

Returns
Type	Description
`ReferenceListServiceClient`

Exceptions
Type	Description
`IOException`

create(ReferenceListServiceStub stub)

public static final ReferenceListServiceClient create(ReferenceListServiceStub stub)

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

Parameter
Name	Description
`stub`	`ReferenceListServiceStub`

Returns
Type	Description
`ReferenceListServiceClient`

Constructors

ReferenceListServiceClient(ReferenceListServiceSettings settings)

protected ReferenceListServiceClient(ReferenceListServiceSettings settings)

Constructs an instance of ReferenceListServiceClient, 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`	`ReferenceListServiceSettings`

ReferenceListServiceClient(ReferenceListServiceStub stub)

protected ReferenceListServiceClient(ReferenceListServiceStub stub)

Parameter
Name	Description
`stub`	`ReferenceListServiceStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

createReferenceList(CreateReferenceListRequest request)

public final ReferenceList createReferenceList(CreateReferenceListRequest request)

Creates a new reference list.

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 (ReferenceListServiceClient referenceListServiceClient =
     ReferenceListServiceClient.create()) {
   CreateReferenceListRequest request =
       CreateReferenceListRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setReferenceList(ReferenceList.newBuilder().build())
           .setReferenceListId("referenceListId676417924")
           .build();
   ReferenceList response = referenceListServiceClient.createReferenceList(request);
 }

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

Returns
Type	Description
`ReferenceList`

createReferenceList(InstanceName parent, ReferenceList referenceList, String referenceListId)

public final ReferenceList createReferenceList(InstanceName parent, ReferenceList referenceList, String referenceListId)

Creates a new reference list.

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 (ReferenceListServiceClient referenceListServiceClient =
     ReferenceListServiceClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   ReferenceList referenceList = ReferenceList.newBuilder().build();
   String referenceListId = "referenceListId676417924";
   ReferenceList response =
       referenceListServiceClient.createReferenceList(parent, referenceList, referenceListId);
 }

Parameters
Name	Description
`parent`	`InstanceName` Required. The parent resource where this reference list will be created. Format: `projects/{project}/locations/{location}/instances/{instance}`
`referenceList`	`ReferenceList` Required. The reference list to create.
`referenceListId`	`String` Required. The ID to use for the reference list. This is also the display name for the reference list. It must satisfy the following requirements: - Starts with letter. - Contains only letters, numbers and underscore. - Has length less than 256. - Must be unique.

Returns
Type	Description
`ReferenceList`

createReferenceList(String parent, ReferenceList referenceList, String referenceListId)

public final ReferenceList createReferenceList(String parent, ReferenceList referenceList, String referenceListId)

Creates a new reference list.

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 (ReferenceListServiceClient referenceListServiceClient =
     ReferenceListServiceClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   ReferenceList referenceList = ReferenceList.newBuilder().build();
   String referenceListId = "referenceListId676417924";
   ReferenceList response =
       referenceListServiceClient.createReferenceList(parent, referenceList, referenceListId);
 }

Parameters
Name	Description
`parent`	`String` Required. The parent resource where this reference list will be created. Format: `projects/{project}/locations/{location}/instances/{instance}`
`referenceList`	`ReferenceList` Required. The reference list to create.
`referenceListId`	`String` Required. The ID to use for the reference list. This is also the display name for the reference list. It must satisfy the following requirements: - Starts with letter. - Contains only letters, numbers and underscore. - Has length less than 256. - Must be unique.

Returns
Type	Description
`ReferenceList`

createReferenceListCallable()

public final UnaryCallable<CreateReferenceListRequest,ReferenceList> createReferenceListCallable()

Creates a new reference list.

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 (ReferenceListServiceClient referenceListServiceClient =
     ReferenceListServiceClient.create()) {
   CreateReferenceListRequest request =
       CreateReferenceListRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setReferenceList(ReferenceList.newBuilder().build())
           .setReferenceListId("referenceListId676417924")
           .build();
   ApiFuture<ReferenceList> future =
       referenceListServiceClient.createReferenceListCallable().futureCall(request);
   // Do something.
   ReferenceList response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateReferenceListRequest,ReferenceList>`

getReferenceList(GetReferenceListRequest request)

public final ReferenceList getReferenceList(GetReferenceListRequest request)

Gets a single reference list.

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 (ReferenceListServiceClient referenceListServiceClient =
     ReferenceListServiceClient.create()) {
   GetReferenceListRequest request =
       GetReferenceListRequest.newBuilder()
           .setName(
               ReferenceListName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[REFERENCE_LIST]")
                   .toString())
           .setView(ReferenceListView.forNumber(0))
           .build();
   ReferenceList response = referenceListServiceClient.getReferenceList(request);
 }

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

Returns
Type	Description
`ReferenceList`

getReferenceList(ReferenceListName name)

public final ReferenceList getReferenceList(ReferenceListName name)

Gets a single reference list.

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 (ReferenceListServiceClient referenceListServiceClient =
     ReferenceListServiceClient.create()) {
   ReferenceListName name =
       ReferenceListName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[REFERENCE_LIST]");
   ReferenceList response = referenceListServiceClient.getReferenceList(name);
 }

Parameter
Name	Description
`name`	`ReferenceListName` Required. The resource name of the reference list to retrieve. Format: `projects/{project}/locations/{locations}/instances/{instance}/referenceLists/{reference_list}`

Returns
Type	Description
`ReferenceList`

getReferenceList(String name)

public final ReferenceList getReferenceList(String name)

Gets a single reference list.

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 (ReferenceListServiceClient referenceListServiceClient =
     ReferenceListServiceClient.create()) {
   String name =
       ReferenceListName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[REFERENCE_LIST]")
           .toString();
   ReferenceList response = referenceListServiceClient.getReferenceList(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the reference list to retrieve. Format: `projects/{project}/locations/{locations}/instances/{instance}/referenceLists/{reference_list}`

Returns
Type	Description
`ReferenceList`

getReferenceListCallable()

public final UnaryCallable<GetReferenceListRequest,ReferenceList> getReferenceListCallable()

Gets a single reference list.

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 (ReferenceListServiceClient referenceListServiceClient =
     ReferenceListServiceClient.create()) {
   GetReferenceListRequest request =
       GetReferenceListRequest.newBuilder()
           .setName(
               ReferenceListName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[REFERENCE_LIST]")
                   .toString())
           .setView(ReferenceListView.forNumber(0))
           .build();
   ApiFuture<ReferenceList> future =
       referenceListServiceClient.getReferenceListCallable().futureCall(request);
   // Do something.
   ReferenceList response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetReferenceListRequest,ReferenceList>`

getSettings()

public final ReferenceListServiceSettings getSettings()

Returns
Type	Description
`ReferenceListServiceSettings`

getStub()

public ReferenceListServiceStub getStub()

Returns
Type	Description
`ReferenceListServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listReferenceLists(InstanceName parent)

public final ReferenceListServiceClient.ListReferenceListsPagedResponse listReferenceLists(InstanceName parent)

Lists a collection of reference lists.

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 (ReferenceListServiceClient referenceListServiceClient =
     ReferenceListServiceClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   for (ReferenceList element :
       referenceListServiceClient.listReferenceLists(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`InstanceName` Required. The parent, which owns this collection of reference lists. Format: `projects/{project}/locations/{location}/instances/{instance}`

Returns
Type	Description
`ReferenceListServiceClient.ListReferenceListsPagedResponse`

listReferenceLists(ListReferenceListsRequest request)

public final ReferenceListServiceClient.ListReferenceListsPagedResponse listReferenceLists(ListReferenceListsRequest request)

Lists a collection of reference lists.

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 (ReferenceListServiceClient referenceListServiceClient =
     ReferenceListServiceClient.create()) {
   ListReferenceListsRequest request =
       ListReferenceListsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setView(ReferenceListView.forNumber(0))
           .build();
   for (ReferenceList element :
       referenceListServiceClient.listReferenceLists(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

Returns
Type	Description
`ReferenceListServiceClient.ListReferenceListsPagedResponse`

listReferenceLists(String parent)

public final ReferenceListServiceClient.ListReferenceListsPagedResponse listReferenceLists(String parent)

Lists a collection of reference lists.

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 (ReferenceListServiceClient referenceListServiceClient =
     ReferenceListServiceClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   for (ReferenceList element :
       referenceListServiceClient.listReferenceLists(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent, which owns this collection of reference lists. Format: `projects/{project}/locations/{location}/instances/{instance}`

Returns
Type	Description
`ReferenceListServiceClient.ListReferenceListsPagedResponse`

listReferenceListsCallable()

public final UnaryCallable<ListReferenceListsRequest,ListReferenceListsResponse> listReferenceListsCallable()

Lists a collection of reference lists.

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 (ReferenceListServiceClient referenceListServiceClient =
     ReferenceListServiceClient.create()) {
   ListReferenceListsRequest request =
       ListReferenceListsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setView(ReferenceListView.forNumber(0))
           .build();
   while (true) {
     ListReferenceListsResponse response =
         referenceListServiceClient.listReferenceListsCallable().call(request);
     for (ReferenceList element : response.getReferenceListsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListReferenceListsRequest,ListReferenceListsResponse>`

listReferenceListsPagedCallable()

public final UnaryCallable<ListReferenceListsRequest,ReferenceListServiceClient.ListReferenceListsPagedResponse> listReferenceListsPagedCallable()

Lists a collection of reference lists.

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 (ReferenceListServiceClient referenceListServiceClient =
     ReferenceListServiceClient.create()) {
   ListReferenceListsRequest request =
       ListReferenceListsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setView(ReferenceListView.forNumber(0))
           .build();
   ApiFuture<ReferenceList> future =
       referenceListServiceClient.listReferenceListsPagedCallable().futureCall(request);
   // Do something.
   for (ReferenceList element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListReferenceListsRequest,ListReferenceListsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateReferenceList(ReferenceList referenceList, FieldMask updateMask)

public final ReferenceList updateReferenceList(ReferenceList referenceList, FieldMask updateMask)

Updates an existing reference list.

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 (ReferenceListServiceClient referenceListServiceClient =
     ReferenceListServiceClient.create()) {
   ReferenceList referenceList = ReferenceList.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   ReferenceList response =
       referenceListServiceClient.updateReferenceList(referenceList, updateMask);
 }

Parameters

Name Description

referenceList

ReferenceList

Required. The reference list to update.

The reference list's name field is used to identify the reference list to update. Format: projects/{project}/locations/{locations}/instances/{instance}/referenceLists/{reference_list}

updateMask

FieldMask

The list of fields to update. When no field mask is supplied, all non-empty fields will be updated. A field mask of "*" will update all fields, whether empty or not.

Returns
Type	Description
`ReferenceList`

updateReferenceList(UpdateReferenceListRequest request)

public final ReferenceList updateReferenceList(UpdateReferenceListRequest request)

Updates an existing reference list.

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 (ReferenceListServiceClient referenceListServiceClient =
     ReferenceListServiceClient.create()) {
   UpdateReferenceListRequest request =
       UpdateReferenceListRequest.newBuilder()
           .setReferenceList(ReferenceList.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ReferenceList response = referenceListServiceClient.updateReferenceList(request);
 }

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

Returns
Type	Description
`ReferenceList`

updateReferenceListCallable()

public final UnaryCallable<UpdateReferenceListRequest,ReferenceList> updateReferenceListCallable()

Updates an existing reference list.

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 (ReferenceListServiceClient referenceListServiceClient =
     ReferenceListServiceClient.create()) {
   UpdateReferenceListRequest request =
       UpdateReferenceListRequest.newBuilder()
           .setReferenceList(ReferenceList.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<ReferenceList> future =
       referenceListServiceClient.updateReferenceListCallable().futureCall(request);
   // Do something.
   ReferenceList response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateReferenceListRequest,ReferenceList>`

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

Inheritance

Static Methods

create()

create(ReferenceListServiceSettings settings)

create(ReferenceListServiceStub stub)

Constructors

ReferenceListServiceClient(ReferenceListServiceSettings settings)

ReferenceListServiceClient(ReferenceListServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

createReferenceList(CreateReferenceListRequest request)

createReferenceList(InstanceName parent, ReferenceList referenceList, String referenceListId)

createReferenceList(String parent, ReferenceList referenceList, String referenceListId)

createReferenceListCallable()

getReferenceList(GetReferenceListRequest request)

getReferenceList(ReferenceListName name)

getReferenceList(String name)

getReferenceListCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

listReferenceLists(InstanceName parent)

listReferenceLists(ListReferenceListsRequest request)

listReferenceLists(String parent)

listReferenceListsCallable()

listReferenceListsPagedCallable()

shutdown()

shutdownNow()

updateReferenceList(ReferenceList referenceList, FieldMask updateMask)

updateReferenceList(UpdateReferenceListRequest request)

updateReferenceListCallable()

Class ReferenceListServiceClient (0.1.0)