@BetaApi @Generated(value="by gapic-generator-java") public class AnswerRecordsClient extends Object implements BackgroundResource
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 (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:
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:
// 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
AnswerRecordsSettings answerRecordsSettings =
AnswerRecordsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create(answerRecordsSettings);
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
AnswerRecordsSettings answerRecordsSettings =
AnswerRecordsSettings.newBuilder().setEndpoint(myEndpoint).build();
AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create(answerRecordsSettings);
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
AnswerRecordsSettings answerRecordsSettings =
AnswerRecordsSettings.newBuilder()
.setTransportChannelProvider(
AnswerRecordsSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create(answerRecordsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Modifier and Type | Class and Description |
---|---|
static class |
AnswerRecordsClient.ListAnswerRecordsFixedSizeCollection |
static class |
AnswerRecordsClient.ListAnswerRecordsPage |
static class |
AnswerRecordsClient.ListAnswerRecordsPagedResponse |
static class |
AnswerRecordsClient.ListLocationsFixedSizeCollection |
static class |
AnswerRecordsClient.ListLocationsPage |
static class |
AnswerRecordsClient.ListLocationsPagedResponse |
Modifier | Constructor and Description |
---|---|
protected |
AnswerRecordsClient(AnswerRecordsSettings settings)
Constructs an instance of AnswerRecordsClient, using the given settings.
|
protected |
AnswerRecordsClient(AnswerRecordsStub stub) |
Modifier and Type | Method and Description |
---|---|
boolean |
awaitTermination(long duration,
TimeUnit unit) |
void |
close() |
static AnswerRecordsClient |
create()
Constructs an instance of AnswerRecordsClient with default settings.
|
static AnswerRecordsClient |
create(AnswerRecordsSettings settings)
Constructs an instance of AnswerRecordsClient, using the given settings.
|
static AnswerRecordsClient |
create(AnswerRecordsStub stub)
Constructs an instance of AnswerRecordsClient, using the given stub for making calls.
|
AnswerRecord |
getAnswerRecord(GetAnswerRecordRequest request)
Deprecated.
This method is deprecated and will be removed in the next major version update.
|
UnaryCallable<GetAnswerRecordRequest,AnswerRecord> |
getAnswerRecordCallable()
Deprecated.
This method is deprecated and will be removed in the next major version update.
|
com.google.cloud.location.Location |
getLocation(com.google.cloud.location.GetLocationRequest request)
Gets information about a location.
|
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
getLocationCallable()
Gets information about a location.
|
AnswerRecordsSettings |
getSettings() |
AnswerRecordsStub |
getStub() |
boolean |
isShutdown() |
boolean |
isTerminated() |
AnswerRecordsClient.ListAnswerRecordsPagedResponse |
listAnswerRecords(ListAnswerRecordsRequest request)
Returns the list of all answer records in the specified project in reverse chronological order.
|
AnswerRecordsClient.ListAnswerRecordsPagedResponse |
listAnswerRecords(LocationName parent)
Returns the list of all answer records in the specified project in reverse chronological order.
|
AnswerRecordsClient.ListAnswerRecordsPagedResponse |
listAnswerRecords(ProjectName parent)
Returns the list of all answer records in the specified project in reverse chronological order.
|
AnswerRecordsClient.ListAnswerRecordsPagedResponse |
listAnswerRecords(String parent)
Returns the list of all answer records in the specified project in reverse chronological order.
|
UnaryCallable<ListAnswerRecordsRequest,ListAnswerRecordsResponse> |
listAnswerRecordsCallable()
Returns the list of all answer records in the specified project in reverse chronological order.
|
UnaryCallable<ListAnswerRecordsRequest,AnswerRecordsClient.ListAnswerRecordsPagedResponse> |
listAnswerRecordsPagedCallable()
Returns the list of all answer records in the specified project in reverse chronological order.
|
AnswerRecordsClient.ListLocationsPagedResponse |
listLocations(com.google.cloud.location.ListLocationsRequest request)
Lists information about the supported locations for this service.
|
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> |
listLocationsCallable()
Lists information about the supported locations for this service.
|
UnaryCallable<com.google.cloud.location.ListLocationsRequest,AnswerRecordsClient.ListLocationsPagedResponse> |
listLocationsPagedCallable()
Lists information about the supported locations for this service.
|
void |
shutdown() |
void |
shutdownNow() |
AnswerRecord |
updateAnswerRecord(AnswerRecord answerRecord,
FieldMask updateMask)
Updates the specified answer record.
|
AnswerRecord |
updateAnswerRecord(UpdateAnswerRecordRequest request)
Updates the specified answer record.
|
UnaryCallable<UpdateAnswerRecordRequest,AnswerRecord> |
updateAnswerRecordCallable()
Updates the specified answer record.
|
protected AnswerRecordsClient(AnswerRecordsSettings settings) throws IOException
IOException
protected AnswerRecordsClient(AnswerRecordsStub stub)
public static final AnswerRecordsClient create() throws IOException
IOException
public static final AnswerRecordsClient create(AnswerRecordsSettings settings) throws IOException
IOException
public static final AnswerRecordsClient create(AnswerRecordsStub stub)
public final AnswerRecordsSettings getSettings()
public AnswerRecordsStub getStub()
@Deprecated public final AnswerRecord getAnswerRecord(GetAnswerRecordRequest request)
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 (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
GetAnswerRecordRequest request =
GetAnswerRecordRequest.newBuilder().setName("name3373707").build();
AnswerRecord response = answerRecordsClient.getAnswerRecord(request);
}
request
- The request object containing all of the parameters for the API call.ApiException
- if the remote call fails@Deprecated public final UnaryCallable<GetAnswerRecordRequest,AnswerRecord> getAnswerRecordCallable()
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 (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
GetAnswerRecordRequest request =
GetAnswerRecordRequest.newBuilder().setName("name3373707").build();
ApiFuture<AnswerRecord> future =
answerRecordsClient.getAnswerRecordCallable().futureCall(request);
// Do something.
AnswerRecord response = future.get();
}
public final AnswerRecordsClient.ListAnswerRecordsPagedResponse listAnswerRecords(LocationName parent)
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 (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (AnswerRecord element : answerRecordsClient.listAnswerRecords(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent
- Required. The project to list all answer records for in reverse chronological
order. Format: `projects/<Project ID>/locations/<Location ID>`.ApiException
- if the remote call failspublic final AnswerRecordsClient.ListAnswerRecordsPagedResponse listAnswerRecords(ProjectName parent)
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 (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
ProjectName parent = ProjectName.of("[PROJECT]");
for (AnswerRecord element : answerRecordsClient.listAnswerRecords(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent
- Required. The project to list all answer records for in reverse chronological
order. Format: `projects/<Project ID>/locations/<Location ID>`.ApiException
- if the remote call failspublic final AnswerRecordsClient.ListAnswerRecordsPagedResponse listAnswerRecords(String parent)
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 (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
String parent = ProjectName.of("[PROJECT]").toString();
for (AnswerRecord element : answerRecordsClient.listAnswerRecords(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent
- Required. The project to list all answer records for in reverse chronological
order. Format: `projects/<Project ID>/locations/<Location ID>`.ApiException
- if the remote call failspublic final AnswerRecordsClient.ListAnswerRecordsPagedResponse listAnswerRecords(ListAnswerRecordsRequest request)
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 (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
ListAnswerRecordsRequest request =
ListAnswerRecordsRequest.newBuilder()
.setParent(ProjectName.of("[PROJECT]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (AnswerRecord element : answerRecordsClient.listAnswerRecords(request).iterateAll()) {
// doThingsWith(element);
}
}
request
- The request object containing all of the parameters for the API call.ApiException
- if the remote call failspublic final UnaryCallable<ListAnswerRecordsRequest,AnswerRecordsClient.ListAnswerRecordsPagedResponse> listAnswerRecordsPagedCallable()
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 (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
ListAnswerRecordsRequest request =
ListAnswerRecordsRequest.newBuilder()
.setParent(ProjectName.of("[PROJECT]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<AnswerRecord> future =
answerRecordsClient.listAnswerRecordsPagedCallable().futureCall(request);
// Do something.
for (AnswerRecord element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final UnaryCallable<ListAnswerRecordsRequest,ListAnswerRecordsResponse> listAnswerRecordsCallable()
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 (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
ListAnswerRecordsRequest request =
ListAnswerRecordsRequest.newBuilder()
.setParent(ProjectName.of("[PROJECT]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListAnswerRecordsResponse response =
answerRecordsClient.listAnswerRecordsCallable().call(request);
for (AnswerRecord element : response.getAnswerRecordsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
public final AnswerRecord updateAnswerRecord(AnswerRecord answerRecord, FieldMask updateMask)
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 (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
AnswerRecord answerRecord = AnswerRecord.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
AnswerRecord response = answerRecordsClient.updateAnswerRecord(answerRecord, updateMask);
}
answerRecord
- Required. Answer record to update.updateMask
- Required. The mask to control which fields get updated.ApiException
- if the remote call failspublic final AnswerRecord updateAnswerRecord(UpdateAnswerRecordRequest request)
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 (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
UpdateAnswerRecordRequest request =
UpdateAnswerRecordRequest.newBuilder()
.setAnswerRecord(AnswerRecord.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
AnswerRecord response = answerRecordsClient.updateAnswerRecord(request);
}
request
- The request object containing all of the parameters for the API call.ApiException
- if the remote call failspublic final UnaryCallable<UpdateAnswerRecordRequest,AnswerRecord> updateAnswerRecordCallable()
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 (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();
}
public final AnswerRecordsClient.ListLocationsPagedResponse listLocations(com.google.cloud.location.ListLocationsRequest request)
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 (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Location element : answerRecordsClient.listLocations(request).iterateAll()) {
// doThingsWith(element);
}
}
request
- The request object containing all of the parameters for the API call.ApiException
- if the remote call failspublic final UnaryCallable<com.google.cloud.location.ListLocationsRequest,AnswerRecordsClient.ListLocationsPagedResponse> listLocationsPagedCallable()
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 (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future =
answerRecordsClient.listLocationsPagedCallable().futureCall(request);
// Do something.
for (Location element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> listLocationsCallable()
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 (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response = answerRecordsClient.listLocationsCallable().call(request);
for (Location element : response.getLocationsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
public final com.google.cloud.location.Location getLocation(com.google.cloud.location.GetLocationRequest request)
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 (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = answerRecordsClient.getLocation(request);
}
request
- The request object containing all of the parameters for the API call.ApiException
- if the remote call failspublic final UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationCallable()
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 (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future = answerRecordsClient.getLocationCallable().futureCall(request);
// Do something.
Location response = future.get();
}
public final void close()
close
in interface AutoCloseable
public void shutdown()
shutdown
in interface BackgroundResource
public boolean isShutdown()
isShutdown
in interface BackgroundResource
public boolean isTerminated()
isTerminated
in interface BackgroundResource
public void shutdownNow()
shutdownNow
in interface BackgroundResource
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
awaitTermination
in interface BackgroundResource
InterruptedException
Copyright © 2022 Google LLC. All rights reserved.