- 4.60.0 (latest)
- 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 ContextsClient implements BackgroundResourceService Description: Service for managing Contexts.
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 (ContextsClient contextsClient = ContextsClient.create()) {
ContextName name =
ContextName.ofProjectSessionContextName("[PROJECT]", "[SESSION]", "[CONTEXT]");
Context response = contextsClient.getContext(name);
}
Note: close() needs to be called on the ContextsClient 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:
- 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.
- 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.
- 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 ContextsSettings to create(). For example:
To customize credentials:
ContextsSettings contextsSettings =
ContextsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ContextsClient contextsClient = ContextsClient.create(contextsSettings);
To customize the endpoint:
ContextsSettings contextsSettings =
ContextsSettings.newBuilder().setEndpoint(myEndpoint).build();
ContextsClient contextsClient = ContextsClient.create(contextsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final ContextsClient create()Constructs an instance of ContextsClient with default settings.
| Type | Description |
| ContextsClient |
| Type | Description |
| IOException |
create(ContextsSettings settings)
public static final ContextsClient create(ContextsSettings settings)Constructs an instance of ContextsClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
| Name | Description |
| settings | ContextsSettings |
| Type | Description |
| ContextsClient |
| Type | Description |
| IOException |
create(ContextsStub stub)
public static final ContextsClient create(ContextsStub stub)Constructs an instance of ContextsClient, using the given stub for making calls. This is for advanced usage - prefer using create(ContextsSettings).
| Name | Description |
| stub | ContextsStub |
| Type | Description |
| ContextsClient |
Constructors
ContextsClient(ContextsSettings settings)
protected ContextsClient(ContextsSettings settings)Constructs an instance of ContextsClient, 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.
| Name | Description |
| settings | ContextsSettings |
ContextsClient(ContextsStub stub)
protected ContextsClient(ContextsStub stub)| Name | Description |
| stub | ContextsStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)| Name | Description |
| duration | long |
| unit | TimeUnit |
| Type | Description |
| boolean |
| Type | Description |
| InterruptedException |
close()
public final void close()createContext(CreateContextRequest request)
public final Context createContext(CreateContextRequest request)Creates a context.
If the specified context already exists, overrides the context.
Sample code:
try (ContextsClient contextsClient = ContextsClient.create()) {
CreateContextRequest request =
CreateContextRequest.newBuilder()
.setParent(SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString())
.setContext(Context.newBuilder().build())
.build();
Context response = contextsClient.createContext(request);
}
| Name | Description |
| request | CreateContextRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| Context |
createContext(SessionName parent, Context context)
public final Context createContext(SessionName parent, Context context)Creates a context.
If the specified context already exists, overrides the context.
Sample code:
try (ContextsClient contextsClient = ContextsClient.create()) {
SessionName parent = SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]");
Context context = Context.newBuilder().build();
Context response = contextsClient.createContext(parent, context);
}
| Name | Description |
| parent | SessionNameRequired. The session to create a context for. Supported formats: -
|
| context | ContextRequired. The context to create. |
| Type | Description |
| Context |
createContext(String parent, Context context)
public final Context createContext(String parent, Context context)Creates a context.
If the specified context already exists, overrides the context.
Sample code:
try (ContextsClient contextsClient = ContextsClient.create()) {
String parent = SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString();
Context context = Context.newBuilder().build();
Context response = contextsClient.createContext(parent, context);
}
| Name | Description |
| parent | StringRequired. The session to create a context for. Supported formats: -
|
| context | ContextRequired. The context to create. |
| Type | Description |
| Context |
createContextCallable()
public final UnaryCallable<CreateContextRequest,Context> createContextCallable()Creates a context.
If the specified context already exists, overrides the context.
Sample code:
try (ContextsClient contextsClient = ContextsClient.create()) {
CreateContextRequest request =
CreateContextRequest.newBuilder()
.setParent(SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString())
.setContext(Context.newBuilder().build())
.build();
ApiFuture<Context> future = contextsClient.createContextCallable().futureCall(request);
// Do something.
Context response = future.get();
}
| Type | Description |
| UnaryCallable<CreateContextRequest,Context> |
deleteAllContexts(DeleteAllContextsRequest request)
public final void deleteAllContexts(DeleteAllContextsRequest request)Deletes all active contexts in the specified session.
Sample code:
try (ContextsClient contextsClient = ContextsClient.create()) {
DeleteAllContextsRequest request =
DeleteAllContextsRequest.newBuilder()
.setParent(SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString())
.build();
contextsClient.deleteAllContexts(request);
}
| Name | Description |
| request | DeleteAllContextsRequestThe request object containing all of the parameters for the API call. |
deleteAllContexts(SessionName parent)
public final void deleteAllContexts(SessionName parent)Deletes all active contexts in the specified session.
Sample code:
try (ContextsClient contextsClient = ContextsClient.create()) {
SessionName parent = SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]");
contextsClient.deleteAllContexts(parent);
}
| Name | Description |
| parent | SessionNameRequired. The name of the session to delete all contexts from. Supported formats:
|
deleteAllContexts(String parent)
public final void deleteAllContexts(String parent)Deletes all active contexts in the specified session.
Sample code:
try (ContextsClient contextsClient = ContextsClient.create()) {
String parent = SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString();
contextsClient.deleteAllContexts(parent);
}
| Name | Description |
| parent | StringRequired. The name of the session to delete all contexts from. Supported formats:
|
deleteAllContextsCallable()
public final UnaryCallable<DeleteAllContextsRequest,Empty> deleteAllContextsCallable()Deletes all active contexts in the specified session.
Sample code:
try (ContextsClient contextsClient = ContextsClient.create()) {
DeleteAllContextsRequest request =
DeleteAllContextsRequest.newBuilder()
.setParent(SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString())
.build();
ApiFuture<Empty> future = contextsClient.deleteAllContextsCallable().futureCall(request);
// Do something.
future.get();
}
| Type | Description |
| UnaryCallable<DeleteAllContextsRequest,Empty> |
deleteContext(ContextName name)
public final void deleteContext(ContextName name)Deletes the specified context.
Sample code:
try (ContextsClient contextsClient = ContextsClient.create()) {
ContextName name =
ContextName.ofProjectSessionContextName("[PROJECT]", "[SESSION]", "[CONTEXT]");
contextsClient.deleteContext(name);
}
| Name | Description |
| name | ContextNameRequired. The name of the context to delete. Supported formats: -
If |
deleteContext(DeleteContextRequest request)
public final void deleteContext(DeleteContextRequest request)Deletes the specified context.
Sample code:
try (ContextsClient contextsClient = ContextsClient.create()) {
DeleteContextRequest request =
DeleteContextRequest.newBuilder()
.setName(
ContextName.ofProjectSessionContextName("[PROJECT]", "[SESSION]", "[CONTEXT]")
.toString())
.build();
contextsClient.deleteContext(request);
}
| Name | Description |
| request | DeleteContextRequestThe request object containing all of the parameters for the API call. |
deleteContext(String name)
public final void deleteContext(String name)Deletes the specified context.
Sample code:
try (ContextsClient contextsClient = ContextsClient.create()) {
String name =
ContextName.ofProjectSessionContextName("[PROJECT]", "[SESSION]", "[CONTEXT]").toString();
contextsClient.deleteContext(name);
}
| Name | Description |
| name | StringRequired. The name of the context to delete. Supported formats: -
If |
deleteContextCallable()
public final UnaryCallable<DeleteContextRequest,Empty> deleteContextCallable()Deletes the specified context.
Sample code:
try (ContextsClient contextsClient = ContextsClient.create()) {
DeleteContextRequest request =
DeleteContextRequest.newBuilder()
.setName(
ContextName.ofProjectSessionContextName("[PROJECT]", "[SESSION]", "[CONTEXT]")
.toString())
.build();
ApiFuture<Empty> future = contextsClient.deleteContextCallable().futureCall(request);
// Do something.
future.get();
}
| Type | Description |
| UnaryCallable<DeleteContextRequest,Empty> |
getContext(ContextName name)
public final Context getContext(ContextName name)Retrieves the specified context.
Sample code:
try (ContextsClient contextsClient = ContextsClient.create()) {
ContextName name =
ContextName.ofProjectSessionContextName("[PROJECT]", "[SESSION]", "[CONTEXT]");
Context response = contextsClient.getContext(name);
}
| Name | Description |
| name | ContextNameRequired. The name of the context. Supported formats: - If |
| Type | Description |
| Context |
getContext(GetContextRequest request)
public final Context getContext(GetContextRequest request)Retrieves the specified context.
Sample code:
try (ContextsClient contextsClient = ContextsClient.create()) {
GetContextRequest request =
GetContextRequest.newBuilder()
.setName(
ContextName.ofProjectSessionContextName("[PROJECT]", "[SESSION]", "[CONTEXT]")
.toString())
.build();
Context response = contextsClient.getContext(request);
}
| Name | Description |
| request | GetContextRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| Context |
getContext(String name)
public final Context getContext(String name)Retrieves the specified context.
Sample code:
try (ContextsClient contextsClient = ContextsClient.create()) {
String name =
ContextName.ofProjectSessionContextName("[PROJECT]", "[SESSION]", "[CONTEXT]").toString();
Context response = contextsClient.getContext(name);
}
| Name | Description |
| name | StringRequired. The name of the context. Supported formats: - If |
| Type | Description |
| Context |
getContextCallable()
public final UnaryCallable<GetContextRequest,Context> getContextCallable()Retrieves the specified context.
Sample code:
try (ContextsClient contextsClient = ContextsClient.create()) {
GetContextRequest request =
GetContextRequest.newBuilder()
.setName(
ContextName.ofProjectSessionContextName("[PROJECT]", "[SESSION]", "[CONTEXT]")
.toString())
.build();
ApiFuture<Context> future = contextsClient.getContextCallable().futureCall(request);
// Do something.
Context response = future.get();
}
| Type | Description |
| UnaryCallable<GetContextRequest,Context> |
getSettings()
public final ContextsSettings getSettings()| Type | Description |
| ContextsSettings |
getStub()
public ContextsStub getStub()| Type | Description |
| ContextsStub |
isShutdown()
public boolean isShutdown()| Type | Description |
| boolean |
isTerminated()
public boolean isTerminated()| Type | Description |
| boolean |
listContexts(ListContextsRequest request)
public final ContextsClient.ListContextsPagedResponse listContexts(ListContextsRequest request)Returns the list of all contexts in the specified session.
Sample code:
try (ContextsClient contextsClient = ContextsClient.create()) {
ListContextsRequest request =
ListContextsRequest.newBuilder()
.setParent(SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Context element : contextsClient.listContexts(request).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| request | ListContextsRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| ContextsClient.ListContextsPagedResponse |
listContexts(SessionName parent)
public final ContextsClient.ListContextsPagedResponse listContexts(SessionName parent)Returns the list of all contexts in the specified session.
Sample code:
try (ContextsClient contextsClient = ContextsClient.create()) {
SessionName parent = SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]");
for (Context element : contextsClient.listContexts(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| parent | SessionNameRequired. The session to list all contexts from. Supported formats: -
|
| Type | Description |
| ContextsClient.ListContextsPagedResponse |
listContexts(String parent)
public final ContextsClient.ListContextsPagedResponse listContexts(String parent)Returns the list of all contexts in the specified session.
Sample code:
try (ContextsClient contextsClient = ContextsClient.create()) {
String parent = SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString();
for (Context element : contextsClient.listContexts(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| parent | StringRequired. The session to list all contexts from. Supported formats: -
|
| Type | Description |
| ContextsClient.ListContextsPagedResponse |
listContextsCallable()
public final UnaryCallable<ListContextsRequest,ListContextsResponse> listContextsCallable()Returns the list of all contexts in the specified session.
Sample code:
try (ContextsClient contextsClient = ContextsClient.create()) {
ListContextsRequest request =
ListContextsRequest.newBuilder()
.setParent(SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListContextsResponse response = contextsClient.listContextsCallable().call(request);
for (Context element : response.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Type | Description |
| UnaryCallable<ListContextsRequest,ListContextsResponse> |
listContextsPagedCallable()
public final UnaryCallable<ListContextsRequest,ContextsClient.ListContextsPagedResponse> listContextsPagedCallable()Returns the list of all contexts in the specified session.
Sample code:
try (ContextsClient contextsClient = ContextsClient.create()) {
ListContextsRequest request =
ListContextsRequest.newBuilder()
.setParent(SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Context> future = contextsClient.listContextsPagedCallable().futureCall(request);
// Do something.
for (Context element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Type | Description |
| UnaryCallable<ListContextsRequest,ListContextsPagedResponse> |
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()updateContext(Context context)
public final Context updateContext(Context context)Updates the specified context.
Sample code:
try (ContextsClient contextsClient = ContextsClient.create()) {
Context context = Context.newBuilder().build();
Context response = contextsClient.updateContext(context);
}
| Name | Description |
| context | ContextRequired. The context to update. |
| Type | Description |
| Context |
updateContext(Context context, FieldMask updateMask)
public final Context updateContext(Context context, FieldMask updateMask)Updates the specified context.
Sample code:
try (ContextsClient contextsClient = ContextsClient.create()) {
Context context = Context.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Context response = contextsClient.updateContext(context, updateMask);
}
| Name | Description |
| context | ContextRequired. The context to update. |
| updateMask | FieldMaskOptional. The mask to control which fields get updated. |
| Type | Description |
| Context |
updateContext(UpdateContextRequest request)
public final Context updateContext(UpdateContextRequest request)Updates the specified context.
Sample code:
try (ContextsClient contextsClient = ContextsClient.create()) {
UpdateContextRequest request =
UpdateContextRequest.newBuilder()
.setContext(Context.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Context response = contextsClient.updateContext(request);
}
| Name | Description |
| request | UpdateContextRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| Context |
updateContextCallable()
public final UnaryCallable<UpdateContextRequest,Context> updateContextCallable()Updates the specified context.
Sample code:
try (ContextsClient contextsClient = ContextsClient.create()) {
UpdateContextRequest request =
UpdateContextRequest.newBuilder()
.setContext(Context.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Context> future = contextsClient.updateContextCallable().futureCall(request);
// Do something.
Context response = future.get();
}
| Type | Description |
| UnaryCallable<UpdateContextRequest,Context> |