Class AnswerRecordsClient (4.5.11)

Version 4.5.11

• 4.61.0 (latest)
• 4.60.0
• 4.59.0
• 4.58.0
• 4.57.0
• 4.55.0
• 4.54.0
• 4.53.0
• 4.52.0
• 4.51.0
• 4.50.0
• 4.49.0
• 4.48.0
• 4.47.0
• 4.46.0
• 4.45.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.35.0
• 4.34.0
• 4.33.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.23.0
• 4.22.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.1
• 4.8.6
• 4.7.5
• 4.6.0
• 4.5.11
• 4.4.0
• 4.3.1

public class AnswerRecordsClient implements BackgroundResource

Service Description: Service for managing AnswerRecords.

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:

 try (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
   GetAnswerRecordRequest request =
       GetAnswerRecordRequest.newBuilder().setName("name3373707").build();
   AnswerRecord response = answerRecordsClient.getAnswerRecord(request);
 }
 

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

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

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

See the individual methods for example code.

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

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

To customize credentials:

 AnswerRecordsSettings answerRecordsSettings =
     AnswerRecordsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create(answerRecordsSettings);
 

To customize the endpoint:

 AnswerRecordsSettings answerRecordsSettings =
     AnswerRecordsSettings.newBuilder().setEndpoint(myEndpoint).build();
 AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create(answerRecordsSettings);
 

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

Inheritance

java.lang.Object > AnswerRecordsClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final AnswerRecordsClient create()

Constructs an instance of AnswerRecordsClient with default settings.

Returns

Type	Description
AnswerRecordsClient

Exceptions

Type	Description
IOException

create(AnswerRecordsSettings settings)

public static final AnswerRecordsClient create(AnswerRecordsSettings settings)

Constructs an instance of AnswerRecordsClient, 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	AnswerRecordsSettings

Returns

Type	Description
AnswerRecordsClient

Exceptions

Type	Description
IOException

create(AnswerRecordsStub stub)

public static final AnswerRecordsClient create(AnswerRecordsStub stub)

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

Parameter

Name	Description
stub	AnswerRecordsStub

Returns

Type	Description
AnswerRecordsClient

Constructors

AnswerRecordsClient(AnswerRecordsSettings settings)

protected AnswerRecordsClient(AnswerRecordsSettings settings)

Constructs an instance of AnswerRecordsClient, 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	AnswerRecordsSettings

AnswerRecordsClient(AnswerRecordsStub stub)

protected AnswerRecordsClient(AnswerRecordsStub stub)

Parameter

Name	Description
stub	AnswerRecordsStub

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

getAnswerRecord(GetAnswerRecordRequest request) (deprecated)

public final AnswerRecord getAnswerRecord(GetAnswerRecordRequest request)

Deprecated. This method is deprecated and will be removed in the next major version update.

Deprecated. Retrieves a specific answer record.

Sample code:

 try (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
   GetAnswerRecordRequest request =
       GetAnswerRecordRequest.newBuilder().setName("name3373707").build();
   AnswerRecord response = answerRecordsClient.getAnswerRecord(request);
 }
 

Parameter

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

Returns

Type	Description
AnswerRecord

getAnswerRecordCallable() (deprecated)

public final UnaryCallable<GetAnswerRecordRequest,AnswerRecord> getAnswerRecordCallable()

Deprecated. This method is deprecated and will be removed in the next major version update.

Deprecated. Retrieves a specific answer record.

Sample code:

 try (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
   GetAnswerRecordRequest request =
       GetAnswerRecordRequest.newBuilder().setName("name3373707").build();
   ApiFuture<AnswerRecord> future =
       answerRecordsClient.getAnswerRecordCallable().futureCall(request);
   // Do something.
   AnswerRecord response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetAnswerRecordRequest,AnswerRecord>

getSettings()

public final AnswerRecordsSettings getSettings()

Returns

Type	Description
AnswerRecordsSettings

getStub()

public AnswerRecordsStub getStub()

Returns

Type	Description
AnswerRecordsStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listAnswerRecords(ListAnswerRecordsRequest request)

public final AnswerRecordsClient.ListAnswerRecordsPagedResponse listAnswerRecords(ListAnswerRecordsRequest request)

Returns the list of all answer records in the specified project in reverse chronological order.

Sample code:

 try (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
   ListAnswerRecordsRequest request =
       ListAnswerRecordsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (AnswerRecord element : answerRecordsClient.listAnswerRecords(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

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

Returns

Type	Description
AnswerRecordsClient.ListAnswerRecordsPagedResponse

listAnswerRecords(LocationName parent)

public final AnswerRecordsClient.ListAnswerRecordsPagedResponse listAnswerRecords(LocationName parent)

Returns the list of all answer records in the specified project in reverse chronological order.

Sample code:

 try (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (AnswerRecord element : answerRecordsClient.listAnswerRecords(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	LocationName Required. The project to list all answer records for in reverse chronological order. Format: projects/<Project ID>/locations/<Location ID>.

Returns

Type	Description
AnswerRecordsClient.ListAnswerRecordsPagedResponse

listAnswerRecords(ProjectName parent)

public final AnswerRecordsClient.ListAnswerRecordsPagedResponse listAnswerRecords(ProjectName parent)

Returns the list of all answer records in the specified project in reverse chronological order.

Sample code:

 try (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (AnswerRecord element : answerRecordsClient.listAnswerRecords(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	ProjectName Required. The project to list all answer records for in reverse chronological order. Format: projects/<Project ID>/locations/<Location ID>.

Returns

Type	Description
AnswerRecordsClient.ListAnswerRecordsPagedResponse

listAnswerRecords(String parent)

public final AnswerRecordsClient.ListAnswerRecordsPagedResponse listAnswerRecords(String parent)

Returns the list of all answer records in the specified project in reverse chronological order.

Sample code:

 try (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   for (AnswerRecord element : answerRecordsClient.listAnswerRecords(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	String Required. The project to list all answer records for in reverse chronological order. Format: projects/<Project ID>/locations/<Location ID>.

Returns

Type	Description
AnswerRecordsClient.ListAnswerRecordsPagedResponse

listAnswerRecordsCallable()

public final UnaryCallable<ListAnswerRecordsRequest,ListAnswerRecordsResponse> listAnswerRecordsCallable()

Returns the list of all answer records in the specified project in reverse chronological order.

Sample code:

 try (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
   ListAnswerRecordsRequest request =
       ListAnswerRecordsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListAnswerRecordsResponse response =
         answerRecordsClient.listAnswerRecordsCallable().call(request);
     for (AnswerRecord element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListAnswerRecordsRequest,ListAnswerRecordsResponse>

listAnswerRecordsPagedCallable()

public final UnaryCallable<ListAnswerRecordsRequest,AnswerRecordsClient.ListAnswerRecordsPagedResponse> listAnswerRecordsPagedCallable()

Returns the list of all answer records in the specified project in reverse chronological order.

Sample code:

 try (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
   ListAnswerRecordsRequest request =
       ListAnswerRecordsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<AnswerRecord> future =
       answerRecordsClient.listAnswerRecordsPagedCallable().futureCall(request);
   // Do something.
   for (AnswerRecord element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListAnswerRecordsRequest,ListAnswerRecordsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAnswerRecord(AnswerRecord answerRecord, FieldMask updateMask)

public final AnswerRecord updateAnswerRecord(AnswerRecord answerRecord, FieldMask updateMask)

Updates the specified answer record.

Sample code:

 try (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
   AnswerRecord answerRecord = AnswerRecord.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   AnswerRecord response = answerRecordsClient.updateAnswerRecord(answerRecord, updateMask);
 }
 

Parameters

Name	Description
answerRecord	AnswerRecord Required. Answer record to update.
updateMask	FieldMask Required. The mask to control which fields get updated.

Returns

Type	Description
AnswerRecord

updateAnswerRecord(UpdateAnswerRecordRequest request)

public final AnswerRecord updateAnswerRecord(UpdateAnswerRecordRequest request)

Updates the specified answer record.

Sample code:

 try (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
   UpdateAnswerRecordRequest request =
       UpdateAnswerRecordRequest.newBuilder()
           .setAnswerRecord(AnswerRecord.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   AnswerRecord response = answerRecordsClient.updateAnswerRecord(request);
 }
 

Parameter

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

Returns

Type	Description
AnswerRecord

updateAnswerRecordCallable()

public final UnaryCallable<UpdateAnswerRecordRequest,AnswerRecord> updateAnswerRecordCallable()

Updates the specified answer record.

Sample code:

 try (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
   UpdateAnswerRecordRequest request =
       UpdateAnswerRecordRequest.newBuilder()
           .setAnswerRecord(AnswerRecord.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<AnswerRecord> future =
       answerRecordsClient.updateAnswerRecordCallable().futureCall(request);
   // Do something.
   AnswerRecord response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<UpdateAnswerRecordRequest,AnswerRecord>