- 4.66.0 (latest)
- 4.65.0
- 4.64.0
- 4.63.0
- 4.62.0
- 4.61.0
- 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 VersionsClient implements BackgroundResourceService Description: Service for managing Versions.
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 (VersionsClient versionsClient = VersionsClient.create()) {
VersionName name = VersionName.ofProjectVersionName("[PROJECT]", "[VERSION]");
Version response = versionsClient.getVersion(name);
}
Note: close() needs to be called on the VersionsClient 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 VersionsSettings to create(). For example:
To customize credentials:
VersionsSettings versionsSettings =
VersionsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
VersionsClient versionsClient = VersionsClient.create(versionsSettings);
To customize the endpoint:
VersionsSettings versionsSettings =
VersionsSettings.newBuilder().setEndpoint(myEndpoint).build();
VersionsClient versionsClient = VersionsClient.create(versionsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceConstructors
VersionsClient(VersionsSettings settings)
protected VersionsClient(VersionsSettings settings)Constructs an instance of VersionsClient, 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 | VersionsSettings |
VersionsClient(VersionsStub stub)
protected VersionsClient(VersionsStub stub)| Name | Description |
| stub | VersionsStub |
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()create()
public static final VersionsClient create()Constructs an instance of VersionsClient with default settings.
| Type | Description |
| VersionsClient |
| Type | Description |
| IOException |
create(VersionsSettings settings)
public static final VersionsClient create(VersionsSettings settings)Constructs an instance of VersionsClient, 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 | VersionsSettings |
| Type | Description |
| VersionsClient |
| Type | Description |
| IOException |
create(VersionsStub stub)
public static final VersionsClient create(VersionsStub stub)Constructs an instance of VersionsClient, using the given stub for making calls. This is for advanced usage - prefer using create(VersionsSettings).
| Name | Description |
| stub | VersionsStub |
| Type | Description |
| VersionsClient |
createVersion(AgentName parent, Version version)
public final Version createVersion(AgentName parent, Version version)Creates an agent version.
The new version points to the agent instance in the "default" environment.
Sample code:
try (VersionsClient versionsClient = VersionsClient.create()) {
AgentName parent = AgentName.ofProjectName("[PROJECT]");
Version version = Version.newBuilder().build();
Version response = versionsClient.createVersion(parent, version);
}
| Name | Description |
| parent | AgentNameRequired. The agent to create a version for. Supported formats: - |
| version | VersionRequired. The version to create. |
| Type | Description |
| Version |
createVersion(CreateVersionRequest request)
public final Version createVersion(CreateVersionRequest request)Creates an agent version.
The new version points to the agent instance in the "default" environment.
Sample code:
try (VersionsClient versionsClient = VersionsClient.create()) {
CreateVersionRequest request =
CreateVersionRequest.newBuilder()
.setParent(AgentName.ofProjectName("[PROJECT]").toString())
.setVersion(Version.newBuilder().build())
.build();
Version response = versionsClient.createVersion(request);
}
| Name | Description |
| request | CreateVersionRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| Version |
createVersion(String parent, Version version)
public final Version createVersion(String parent, Version version)Creates an agent version.
The new version points to the agent instance in the "default" environment.
Sample code:
try (VersionsClient versionsClient = VersionsClient.create()) {
String parent = AgentName.ofProjectName("[PROJECT]").toString();
Version version = Version.newBuilder().build();
Version response = versionsClient.createVersion(parent, version);
}
| Name | Description |
| parent | StringRequired. The agent to create a version for. Supported formats: - |
| version | VersionRequired. The version to create. |
| Type | Description |
| Version |
createVersionCallable()
public final UnaryCallable<CreateVersionRequest,Version> createVersionCallable()Creates an agent version.
The new version points to the agent instance in the "default" environment.
Sample code:
try (VersionsClient versionsClient = VersionsClient.create()) {
CreateVersionRequest request =
CreateVersionRequest.newBuilder()
.setParent(AgentName.ofProjectName("[PROJECT]").toString())
.setVersion(Version.newBuilder().build())
.build();
ApiFuture| Type | Description |
| UnaryCallable<CreateVersionRequest,Version> |
deleteVersion(DeleteVersionRequest request)
public final void deleteVersion(DeleteVersionRequest request)Delete the specified agent version.
Sample code:
try (VersionsClient versionsClient = VersionsClient.create()) {
DeleteVersionRequest request =
DeleteVersionRequest.newBuilder()
.setName(VersionName.ofProjectVersionName("[PROJECT]", "[VERSION]").toString())
.build();
versionsClient.deleteVersion(request);
}
| Name | Description |
| request | DeleteVersionRequestThe request object containing all of the parameters for the API call. |
deleteVersion(VersionName name)
public final void deleteVersion(VersionName name)Delete the specified agent version.
Sample code:
try (VersionsClient versionsClient = VersionsClient.create()) {
VersionName name = VersionName.ofProjectVersionName("[PROJECT]", "[VERSION]");
versionsClient.deleteVersion(name);
}
| Name | Description |
| name | VersionNameRequired. The name of the version to delete. Supported formats: - |
deleteVersion(String name)
public final void deleteVersion(String name)Delete the specified agent version.
Sample code:
try (VersionsClient versionsClient = VersionsClient.create()) {
String name = VersionName.ofProjectVersionName("[PROJECT]", "[VERSION]").toString();
versionsClient.deleteVersion(name);
}
| Name | Description |
| name | StringRequired. The name of the version to delete. Supported formats: - |
deleteVersionCallable()
public final UnaryCallable<DeleteVersionRequest,Empty> deleteVersionCallable()Delete the specified agent version.
Sample code:
try (VersionsClient versionsClient = VersionsClient.create()) {
DeleteVersionRequest request =
DeleteVersionRequest.newBuilder()
.setName(VersionName.ofProjectVersionName("[PROJECT]", "[VERSION]").toString())
.build();
ApiFuture| Type | Description |
| UnaryCallable<DeleteVersionRequest,Empty> |
getSettings()
public final VersionsSettings getSettings()| Type | Description |
| VersionsSettings |
getStub()
public VersionsStub getStub()| Type | Description |
| VersionsStub |
getVersion(GetVersionRequest request)
public final Version getVersion(GetVersionRequest request)Retrieves the specified agent version.
Sample code:
try (VersionsClient versionsClient = VersionsClient.create()) {
GetVersionRequest request =
GetVersionRequest.newBuilder()
.setName(VersionName.ofProjectVersionName("[PROJECT]", "[VERSION]").toString())
.build();
Version response = versionsClient.getVersion(request);
}
| Name | Description |
| request | GetVersionRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| Version |
getVersion(VersionName name)
public final Version getVersion(VersionName name)Retrieves the specified agent version.
Sample code:
try (VersionsClient versionsClient = VersionsClient.create()) {
VersionName name = VersionName.ofProjectVersionName("[PROJECT]", "[VERSION]");
Version response = versionsClient.getVersion(name);
}
| Name | Description |
| name | VersionNameRequired. The name of the version. Supported formats: - |
| Type | Description |
| Version |
getVersion(String name)
public final Version getVersion(String name)Retrieves the specified agent version.
Sample code:
try (VersionsClient versionsClient = VersionsClient.create()) {
String name = VersionName.ofProjectVersionName("[PROJECT]", "[VERSION]").toString();
Version response = versionsClient.getVersion(name);
}
| Name | Description |
| name | StringRequired. The name of the version. Supported formats: - |
| Type | Description |
| Version |
getVersionCallable()
public final UnaryCallable<GetVersionRequest,Version> getVersionCallable()Retrieves the specified agent version.
Sample code:
try (VersionsClient versionsClient = VersionsClient.create()) {
GetVersionRequest request =
GetVersionRequest.newBuilder()
.setName(VersionName.ofProjectVersionName("[PROJECT]", "[VERSION]").toString())
.build();
ApiFuture| Type | Description |
| UnaryCallable<GetVersionRequest,Version> |
isShutdown()
public boolean isShutdown()| Type | Description |
| boolean |
isTerminated()
public boolean isTerminated()| Type | Description |
| boolean |
listVersions(AgentName parent)
public final VersionsClient.ListVersionsPagedResponse listVersions(AgentName parent)Returns the list of all versions of the specified agent.
Sample code:
try (VersionsClient versionsClient = VersionsClient.create()) {
AgentName parent = AgentName.ofProjectName("[PROJECT]");
for (Version element : versionsClient.listVersions(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| parent | AgentNameRequired. The agent to list all versions from. Supported formats: - |
| Type | Description |
| VersionsClient.ListVersionsPagedResponse |
listVersions(ListVersionsRequest request)
public final VersionsClient.ListVersionsPagedResponse listVersions(ListVersionsRequest request)Returns the list of all versions of the specified agent.
Sample code:
try (VersionsClient versionsClient = VersionsClient.create()) {
ListVersionsRequest request =
ListVersionsRequest.newBuilder()
.setParent(AgentName.ofProjectName("[PROJECT]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Version element : versionsClient.listVersions(request).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| request | ListVersionsRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| VersionsClient.ListVersionsPagedResponse |
listVersions(String parent)
public final VersionsClient.ListVersionsPagedResponse listVersions(String parent)Returns the list of all versions of the specified agent.
Sample code:
try (VersionsClient versionsClient = VersionsClient.create()) {
String parent = AgentName.ofProjectName("[PROJECT]").toString();
for (Version element : versionsClient.listVersions(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| parent | StringRequired. The agent to list all versions from. Supported formats: - |
| Type | Description |
| VersionsClient.ListVersionsPagedResponse |
listVersionsCallable()
public final UnaryCallable<ListVersionsRequest,ListVersionsResponse> listVersionsCallable()Returns the list of all versions of the specified agent.
Sample code:
try (VersionsClient versionsClient = VersionsClient.create()) {
ListVersionsRequest request =
ListVersionsRequest.newBuilder()
.setParent(AgentName.ofProjectName("[PROJECT]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListVersionsResponse response = versionsClient.listVersionsCallable().call(request);
for (Version element : response.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Type | Description |
| UnaryCallable<ListVersionsRequest,ListVersionsResponse> |
listVersionsPagedCallable()
public final UnaryCallable<ListVersionsRequest,VersionsClient.ListVersionsPagedResponse> listVersionsPagedCallable()Returns the list of all versions of the specified agent.
Sample code:
try (VersionsClient versionsClient = VersionsClient.create()) {
ListVersionsRequest request =
ListVersionsRequest.newBuilder()
.setParent(AgentName.ofProjectName("[PROJECT]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture| Type | Description |
| UnaryCallable<ListVersionsRequest,ListVersionsPagedResponse> |
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()updateVersion(UpdateVersionRequest request)
public final Version updateVersion(UpdateVersionRequest request)Updates the specified agent version.
Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.
Sample code:
try (VersionsClient versionsClient = VersionsClient.create()) {
UpdateVersionRequest request =
UpdateVersionRequest.newBuilder()
.setVersion(Version.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Version response = versionsClient.updateVersion(request);
}
| Name | Description |
| request | UpdateVersionRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| Version |
updateVersion(Version version, FieldMask updateMask)
public final Version updateVersion(Version version, FieldMask updateMask)Updates the specified agent version.
Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.
Sample code:
try (VersionsClient versionsClient = VersionsClient.create()) {
Version version = Version.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Version response = versionsClient.updateVersion(version, updateMask);
}
| Name | Description |
| version | VersionRequired. The version to update. Supported formats: - |
| updateMask | FieldMaskRequired. The mask to control which fields get updated. |
| Type | Description |
| Version |
updateVersionCallable()
public final UnaryCallable<UpdateVersionRequest,Version> updateVersionCallable()Updates the specified agent version.
Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.
Sample code:
try (VersionsClient versionsClient = VersionsClient.create()) {
UpdateVersionRequest request =
UpdateVersionRequest.newBuilder()
.setVersion(Version.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture| Type | Description |
| UnaryCallable<UpdateVersionRequest,Version> |