- 3.55.0 (latest)
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public class EndpointServiceClient implements BackgroundResource
Service Description: A service for managing Vertex AI's Endpoints.
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 for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
EndpointName name = EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]");
Endpoint response = endpointServiceClient.getEndpoint(name);
}
Note: close() needs to be called on the EndpointServiceClient 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 EndpointServiceSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
EndpointServiceSettings endpointServiceSettings =
EndpointServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
EndpointServiceClient endpointServiceClient =
EndpointServiceClient.create(endpointServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
EndpointServiceSettings endpointServiceSettings =
EndpointServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
EndpointServiceClient endpointServiceClient =
EndpointServiceClient.create(endpointServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final EndpointServiceClient create()
Constructs an instance of EndpointServiceClient with default settings.
Type | Description |
EndpointServiceClient |
Type | Description |
IOException |
create(EndpointServiceSettings settings)
public static final EndpointServiceClient create(EndpointServiceSettings settings)
Constructs an instance of EndpointServiceClient, 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 | EndpointServiceSettings |
Type | Description |
EndpointServiceClient |
Type | Description |
IOException |
create(EndpointServiceStub stub)
public static final EndpointServiceClient create(EndpointServiceStub stub)
Constructs an instance of EndpointServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(EndpointServiceSettings).
Name | Description |
stub | EndpointServiceStub |
Type | Description |
EndpointServiceClient |
Constructors
EndpointServiceClient(EndpointServiceSettings settings)
protected EndpointServiceClient(EndpointServiceSettings settings)
Constructs an instance of EndpointServiceClient, 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 | EndpointServiceSettings |
EndpointServiceClient(EndpointServiceStub stub)
protected EndpointServiceClient(EndpointServiceStub stub)
Name | Description |
stub | EndpointServiceStub |
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()
createEndpointAsync(CreateEndpointRequest request)
public final OperationFuture<Endpoint,CreateEndpointOperationMetadata> createEndpointAsync(CreateEndpointRequest request)
Creates an Endpoint.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
CreateEndpointRequest request =
CreateEndpointRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setEndpoint(Endpoint.newBuilder().build())
.setEndpointId("endpointId-1837754992")
.build();
Endpoint response = endpointServiceClient.createEndpointAsync(request).get();
}
Name | Description |
request | CreateEndpointRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Endpoint,CreateEndpointOperationMetadata> |
createEndpointAsync(LocationName parent, Endpoint endpoint)
public final OperationFuture<Endpoint,CreateEndpointOperationMetadata> createEndpointAsync(LocationName parent, Endpoint endpoint)
Creates an Endpoint.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Endpoint endpoint = Endpoint.newBuilder().build();
Endpoint response = endpointServiceClient.createEndpointAsync(parent, endpoint).get();
}
Name | Description |
parent | LocationName Required. The resource name of the Location to create the Endpoint in. Format:
|
endpoint | Endpoint Required. The Endpoint to create. |
Type | Description |
OperationFuture<Endpoint,CreateEndpointOperationMetadata> |
createEndpointAsync(LocationName parent, Endpoint endpoint, String endpointId)
public final OperationFuture<Endpoint,CreateEndpointOperationMetadata> createEndpointAsync(LocationName parent, Endpoint endpoint, String endpointId)
Creates an Endpoint.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Endpoint endpoint = Endpoint.newBuilder().build();
String endpointId = "endpointId-1837754992";
Endpoint response =
endpointServiceClient.createEndpointAsync(parent, endpoint, endpointId).get();
}
Name | Description |
parent | LocationName Required. The resource name of the Location to create the Endpoint in. Format:
|
endpoint | Endpoint Required. The Endpoint to create. |
endpointId | String Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are /[0-9]/. When using
HTTP/JSON, this field is populated based on a query string argument, such as
|
Type | Description |
OperationFuture<Endpoint,CreateEndpointOperationMetadata> |
createEndpointAsync(String parent, Endpoint endpoint)
public final OperationFuture<Endpoint,CreateEndpointOperationMetadata> createEndpointAsync(String parent, Endpoint endpoint)
Creates an Endpoint.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Endpoint endpoint = Endpoint.newBuilder().build();
Endpoint response = endpointServiceClient.createEndpointAsync(parent, endpoint).get();
}
Name | Description |
parent | String Required. The resource name of the Location to create the Endpoint in. Format:
|
endpoint | Endpoint Required. The Endpoint to create. |
Type | Description |
OperationFuture<Endpoint,CreateEndpointOperationMetadata> |
createEndpointAsync(String parent, Endpoint endpoint, String endpointId)
public final OperationFuture<Endpoint,CreateEndpointOperationMetadata> createEndpointAsync(String parent, Endpoint endpoint, String endpointId)
Creates an Endpoint.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Endpoint endpoint = Endpoint.newBuilder().build();
String endpointId = "endpointId-1837754992";
Endpoint response =
endpointServiceClient.createEndpointAsync(parent, endpoint, endpointId).get();
}
Name | Description |
parent | String Required. The resource name of the Location to create the Endpoint in. Format:
|
endpoint | Endpoint Required. The Endpoint to create. |
endpointId | String Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are /[0-9]/. When using
HTTP/JSON, this field is populated based on a query string argument, such as
|
Type | Description |
OperationFuture<Endpoint,CreateEndpointOperationMetadata> |
createEndpointCallable()
public final UnaryCallable<CreateEndpointRequest,Operation> createEndpointCallable()
Creates an Endpoint.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
CreateEndpointRequest request =
CreateEndpointRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setEndpoint(Endpoint.newBuilder().build())
.setEndpointId("endpointId-1837754992")
.build();
ApiFuture<Operation> future =
endpointServiceClient.createEndpointCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<CreateEndpointRequest,Operation> |
createEndpointOperationCallable()
public final OperationCallable<CreateEndpointRequest,Endpoint,CreateEndpointOperationMetadata> createEndpointOperationCallable()
Creates an Endpoint.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
CreateEndpointRequest request =
CreateEndpointRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setEndpoint(Endpoint.newBuilder().build())
.setEndpointId("endpointId-1837754992")
.build();
OperationFuture<Endpoint, CreateEndpointOperationMetadata> future =
endpointServiceClient.createEndpointOperationCallable().futureCall(request);
// Do something.
Endpoint response = future.get();
}
Type | Description |
OperationCallable<CreateEndpointRequest,Endpoint,CreateEndpointOperationMetadata> |
deleteEndpointAsync(DeleteEndpointRequest request)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteEndpointAsync(DeleteEndpointRequest request)
Deletes an Endpoint.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
DeleteEndpointRequest request =
DeleteEndpointRequest.newBuilder()
.setName(EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]").toString())
.build();
endpointServiceClient.deleteEndpointAsync(request).get();
}
Name | Description |
request | DeleteEndpointRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteEndpointAsync(EndpointName name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteEndpointAsync(EndpointName name)
Deletes an Endpoint.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
EndpointName name = EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]");
endpointServiceClient.deleteEndpointAsync(name).get();
}
Name | Description |
name | EndpointName Required. The name of the Endpoint resource to be deleted. Format:
|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteEndpointAsync(String name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteEndpointAsync(String name)
Deletes an Endpoint.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
String name = EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]").toString();
endpointServiceClient.deleteEndpointAsync(name).get();
}
Name | Description |
name | String Required. The name of the Endpoint resource to be deleted. Format:
|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteEndpointCallable()
public final UnaryCallable<DeleteEndpointRequest,Operation> deleteEndpointCallable()
Deletes an Endpoint.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
DeleteEndpointRequest request =
DeleteEndpointRequest.newBuilder()
.setName(EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]").toString())
.build();
ApiFuture<Operation> future =
endpointServiceClient.deleteEndpointCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
UnaryCallable<DeleteEndpointRequest,Operation> |
deleteEndpointOperationCallable()
public final OperationCallable<DeleteEndpointRequest,Empty,DeleteOperationMetadata> deleteEndpointOperationCallable()
Deletes an Endpoint.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
DeleteEndpointRequest request =
DeleteEndpointRequest.newBuilder()
.setName(EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]").toString())
.build();
OperationFuture<Empty, DeleteOperationMetadata> future =
endpointServiceClient.deleteEndpointOperationCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
OperationCallable<DeleteEndpointRequest,Empty,DeleteOperationMetadata> |
deployModelAsync(DeployModelRequest request)
public final OperationFuture<DeployModelResponse,DeployModelOperationMetadata> deployModelAsync(DeployModelRequest request)
Deploys a Model into this Endpoint, creating a DeployedModel within it.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
DeployModelRequest request =
DeployModelRequest.newBuilder()
.setEndpoint(EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]").toString())
.setDeployedModel(DeployedModel.newBuilder().build())
.putAllTrafficSplit(new HashMap<String, Integer>())
.build();
DeployModelResponse response = endpointServiceClient.deployModelAsync(request).get();
}
Name | Description |
request | DeployModelRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<DeployModelResponse,DeployModelOperationMetadata> |
deployModelAsync(EndpointName endpoint, DeployedModel deployedModel, Map<String,Integer> trafficSplit)
public final OperationFuture<DeployModelResponse,DeployModelOperationMetadata> deployModelAsync(EndpointName endpoint, DeployedModel deployedModel, Map<String,Integer> trafficSplit)
Deploys a Model into this Endpoint, creating a DeployedModel within it.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
EndpointName endpoint = EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]");
DeployedModel deployedModel = DeployedModel.newBuilder().build();
Map<String, Integer> trafficSplit = new HashMap<>();
DeployModelResponse response =
endpointServiceClient.deployModelAsync(endpoint, deployedModel, trafficSplit).get();
}
Name | Description |
endpoint | EndpointName Required. The name of the Endpoint resource into which to deploy a Model.
Format: |
deployedModel | DeployedModel Required. The DeployedModel to be created within the Endpoint. Note that Endpoint.traffic_split must be updated for the DeployedModel to start receiving traffic, either as part of this call, or via EndpointService.UpdateEndpoint. |
trafficSplit | Map<String,Integer> A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If this field is non-empty, then the Endpoint's traffic_split will be overwritten with it. To refer to the ID of the just being deployed Model, a "0" should be used, and the actual ID of the new DeployedModel will be filled in its place by this method. The traffic percentage values must add up to 100. If this field is empty, then the Endpoint's traffic_split is not updated. |
Type | Description |
OperationFuture<DeployModelResponse,DeployModelOperationMetadata> |
deployModelAsync(String endpoint, DeployedModel deployedModel, Map<String,Integer> trafficSplit)
public final OperationFuture<DeployModelResponse,DeployModelOperationMetadata> deployModelAsync(String endpoint, DeployedModel deployedModel, Map<String,Integer> trafficSplit)
Deploys a Model into this Endpoint, creating a DeployedModel within it.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
String endpoint = EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]").toString();
DeployedModel deployedModel = DeployedModel.newBuilder().build();
Map<String, Integer> trafficSplit = new HashMap<>();
DeployModelResponse response =
endpointServiceClient.deployModelAsync(endpoint, deployedModel, trafficSplit).get();
}
Name | Description |
endpoint | String Required. The name of the Endpoint resource into which to deploy a Model.
Format: |
deployedModel | DeployedModel Required. The DeployedModel to be created within the Endpoint. Note that Endpoint.traffic_split must be updated for the DeployedModel to start receiving traffic, either as part of this call, or via EndpointService.UpdateEndpoint. |
trafficSplit | Map<String,Integer> A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If this field is non-empty, then the Endpoint's traffic_split will be overwritten with it. To refer to the ID of the just being deployed Model, a "0" should be used, and the actual ID of the new DeployedModel will be filled in its place by this method. The traffic percentage values must add up to 100. If this field is empty, then the Endpoint's traffic_split is not updated. |
Type | Description |
OperationFuture<DeployModelResponse,DeployModelOperationMetadata> |
deployModelCallable()
public final UnaryCallable<DeployModelRequest,Operation> deployModelCallable()
Deploys a Model into this Endpoint, creating a DeployedModel within it.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
DeployModelRequest request =
DeployModelRequest.newBuilder()
.setEndpoint(EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]").toString())
.setDeployedModel(DeployedModel.newBuilder().build())
.putAllTrafficSplit(new HashMap<String, Integer>())
.build();
ApiFuture<Operation> future = endpointServiceClient.deployModelCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<DeployModelRequest,Operation> |
deployModelOperationCallable()
public final OperationCallable<DeployModelRequest,DeployModelResponse,DeployModelOperationMetadata> deployModelOperationCallable()
Deploys a Model into this Endpoint, creating a DeployedModel within it.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
DeployModelRequest request =
DeployModelRequest.newBuilder()
.setEndpoint(EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]").toString())
.setDeployedModel(DeployedModel.newBuilder().build())
.putAllTrafficSplit(new HashMap<String, Integer>())
.build();
OperationFuture<DeployModelResponse, DeployModelOperationMetadata> future =
endpointServiceClient.deployModelOperationCallable().futureCall(request);
// Do something.
DeployModelResponse response = future.get();
}
Type | Description |
OperationCallable<DeployModelRequest,DeployModelResponse,DeployModelOperationMetadata> |
getEndpoint(EndpointName name)
public final Endpoint getEndpoint(EndpointName name)
Gets an Endpoint.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
EndpointName name = EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]");
Endpoint response = endpointServiceClient.getEndpoint(name);
}
Name | Description |
name | EndpointName Required. The name of the Endpoint resource. Format:
|
Type | Description |
Endpoint |
getEndpoint(GetEndpointRequest request)
public final Endpoint getEndpoint(GetEndpointRequest request)
Gets an Endpoint.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
GetEndpointRequest request =
GetEndpointRequest.newBuilder()
.setName(EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]").toString())
.build();
Endpoint response = endpointServiceClient.getEndpoint(request);
}
Name | Description |
request | GetEndpointRequest The request object containing all of the parameters for the API call. |
Type | Description |
Endpoint |
getEndpoint(String name)
public final Endpoint getEndpoint(String name)
Gets an Endpoint.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
String name = EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]").toString();
Endpoint response = endpointServiceClient.getEndpoint(name);
}
Name | Description |
name | String Required. The name of the Endpoint resource. Format:
|
Type | Description |
Endpoint |
getEndpointCallable()
public final UnaryCallable<GetEndpointRequest,Endpoint> getEndpointCallable()
Gets an Endpoint.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
GetEndpointRequest request =
GetEndpointRequest.newBuilder()
.setName(EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]").toString())
.build();
ApiFuture<Endpoint> future = endpointServiceClient.getEndpointCallable().futureCall(request);
// Do something.
Endpoint response = future.get();
}
Type | Description |
UnaryCallable<GetEndpointRequest,Endpoint> |
getIamPolicy(GetIamPolicyRequest request)
public final Policy getIamPolicy(GetIamPolicyRequest request)
Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
Policy response = endpointServiceClient.getIamPolicy(request);
}
Name | Description |
request | com.google.iam.v1.GetIamPolicyRequest The request object containing all of the parameters for the API call. |
Type | Description |
com.google.iam.v1.Policy |
getIamPolicyCallable()
public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()
Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
ApiFuture<Policy> future = endpointServiceClient.getIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
Type | Description |
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
getLocation(GetLocationRequest request)
public final Location getLocation(GetLocationRequest request)
Gets information about a location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = endpointServiceClient.getLocation(request);
}
Name | Description |
request | com.google.cloud.location.GetLocationRequest The request object containing all of the parameters for the API call. |
Type | Description |
com.google.cloud.location.Location |
getLocationCallable()
public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()
Gets information about a location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future = endpointServiceClient.getLocationCallable().futureCall(request);
// Do something.
Location response = future.get();
}
Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
getOperationsClient()
public final OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Type | Description |
OperationsClient |
getSettings()
public final EndpointServiceSettings getSettings()
Type | Description |
EndpointServiceSettings |
getStub()
public EndpointServiceStub getStub()
Type | Description |
EndpointServiceStub |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Type | Description |
boolean |
listEndpoints(ListEndpointsRequest request)
public final EndpointServiceClient.ListEndpointsPagedResponse listEndpoints(ListEndpointsRequest request)
Lists Endpoints in a Location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
ListEndpointsRequest request =
ListEndpointsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setReadMask(FieldMask.newBuilder().build())
.setOrderBy("orderBy-1207110587")
.build();
for (Endpoint element : endpointServiceClient.listEndpoints(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | ListEndpointsRequest The request object containing all of the parameters for the API call. |
Type | Description |
EndpointServiceClient.ListEndpointsPagedResponse |
listEndpoints(LocationName parent)
public final EndpointServiceClient.ListEndpointsPagedResponse listEndpoints(LocationName parent)
Lists Endpoints in a Location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Endpoint element : endpointServiceClient.listEndpoints(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | LocationName Required. The resource name of the Location from which to list the Endpoints.
Format: |
Type | Description |
EndpointServiceClient.ListEndpointsPagedResponse |
listEndpoints(String parent)
public final EndpointServiceClient.ListEndpointsPagedResponse listEndpoints(String parent)
Lists Endpoints in a Location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Endpoint element : endpointServiceClient.listEndpoints(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The resource name of the Location from which to list the Endpoints.
Format: |
Type | Description |
EndpointServiceClient.ListEndpointsPagedResponse |
listEndpointsCallable()
public final UnaryCallable<ListEndpointsRequest,ListEndpointsResponse> listEndpointsCallable()
Lists Endpoints in a Location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
ListEndpointsRequest request =
ListEndpointsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setReadMask(FieldMask.newBuilder().build())
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListEndpointsResponse response =
endpointServiceClient.listEndpointsCallable().call(request);
for (Endpoint element : response.getEndpointsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListEndpointsRequest,ListEndpointsResponse> |
listEndpointsPagedCallable()
public final UnaryCallable<ListEndpointsRequest,EndpointServiceClient.ListEndpointsPagedResponse> listEndpointsPagedCallable()
Lists Endpoints in a Location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
ListEndpointsRequest request =
ListEndpointsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setReadMask(FieldMask.newBuilder().build())
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<Endpoint> future =
endpointServiceClient.listEndpointsPagedCallable().futureCall(request);
// Do something.
for (Endpoint element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Type | Description |
UnaryCallable<ListEndpointsRequest,ListEndpointsPagedResponse> |
listLocations(ListLocationsRequest request)
public final EndpointServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)
Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Location element : endpointServiceClient.listLocations(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | com.google.cloud.location.ListLocationsRequest The request object containing all of the parameters for the API call. |
Type | Description |
EndpointServiceClient.ListLocationsPagedResponse |
listLocationsCallable()
public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()
Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response =
endpointServiceClient.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;
}
}
}
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> |
listLocationsPagedCallable()
public final UnaryCallable<ListLocationsRequest,EndpointServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()
Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future =
endpointServiceClient.listLocationsPagedCallable().futureCall(request);
// Do something.
for (Location element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
setIamPolicy(SetIamPolicyRequest request)
public final Policy setIamPolicy(SetIamPolicyRequest request)
Sets the access control policy on the specified resource. Replacesany existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Policy response = endpointServiceClient.setIamPolicy(request);
}
Name | Description |
request | com.google.iam.v1.SetIamPolicyRequest The request object containing all of the parameters for the API call. |
Type | Description |
com.google.iam.v1.Policy |
setIamPolicyCallable()
public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()
Sets the access control policy on the specified resource. Replacesany existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Policy> future = endpointServiceClient.setIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
Type | Description |
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
testIamPermissions(TestIamPermissionsRequest request)
public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)
Returns permissions that a caller has on the specified resource. If theresource does not exist,
this will return an empty set ofpermissions, not a NOT_FOUND
error.
Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.addAllPermissions(new ArrayList<String>())
.build();
TestIamPermissionsResponse response = endpointServiceClient.testIamPermissions(request);
}
Name | Description |
request | com.google.iam.v1.TestIamPermissionsRequest The request object containing all of the parameters for the API call. |
Type | Description |
com.google.iam.v1.TestIamPermissionsResponse |
testIamPermissionsCallable()
public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()
Returns permissions that a caller has on the specified resource. If theresource does not exist,
this will return an empty set ofpermissions, not a NOT_FOUND
error.
Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.addAllPermissions(new ArrayList<String>())
.build();
ApiFuture<TestIamPermissionsResponse> future =
endpointServiceClient.testIamPermissionsCallable().futureCall(request);
// Do something.
TestIamPermissionsResponse response = future.get();
}
Type | Description |
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
undeployModelAsync(EndpointName endpoint, String deployedModelId, Map<String,Integer> trafficSplit)
public final OperationFuture<UndeployModelResponse,UndeployModelOperationMetadata> undeployModelAsync(EndpointName endpoint, String deployedModelId, Map<String,Integer> trafficSplit)
Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
EndpointName endpoint = EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]");
String deployedModelId = "deployedModelId-1817547906";
Map<String, Integer> trafficSplit = new HashMap<>();
UndeployModelResponse response =
endpointServiceClient.undeployModelAsync(endpoint, deployedModelId, trafficSplit).get();
}
Name | Description |
endpoint | EndpointName Required. The name of the Endpoint resource from which to undeploy a Model.
Format: |
deployedModelId | String Required. The ID of the DeployedModel to be undeployed from the Endpoint. |
trafficSplit | Map<String,Integer> If this field is provided, then the Endpoint's traffic_split will be overwritten with it. If last DeployedModel is being undeployed from the Endpoint, the [Endpoint.traffic_split] will always end up empty when this call returns. A DeployedModel will be successfully undeployed only if it doesn't have any traffic assigned to it when this method executes, or if this field unassigns any traffic to it. |
Type | Description |
OperationFuture<UndeployModelResponse,UndeployModelOperationMetadata> |
undeployModelAsync(UndeployModelRequest request)
public final OperationFuture<UndeployModelResponse,UndeployModelOperationMetadata> undeployModelAsync(UndeployModelRequest request)
Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
UndeployModelRequest request =
UndeployModelRequest.newBuilder()
.setEndpoint(EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]").toString())
.setDeployedModelId("deployedModelId-1817547906")
.putAllTrafficSplit(new HashMap<String, Integer>())
.build();
UndeployModelResponse response = endpointServiceClient.undeployModelAsync(request).get();
}
Name | Description |
request | UndeployModelRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<UndeployModelResponse,UndeployModelOperationMetadata> |
undeployModelAsync(String endpoint, String deployedModelId, Map<String,Integer> trafficSplit)
public final OperationFuture<UndeployModelResponse,UndeployModelOperationMetadata> undeployModelAsync(String endpoint, String deployedModelId, Map<String,Integer> trafficSplit)
Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
String endpoint = EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]").toString();
String deployedModelId = "deployedModelId-1817547906";
Map<String, Integer> trafficSplit = new HashMap<>();
UndeployModelResponse response =
endpointServiceClient.undeployModelAsync(endpoint, deployedModelId, trafficSplit).get();
}
Name | Description |
endpoint | String Required. The name of the Endpoint resource from which to undeploy a Model.
Format: |
deployedModelId | String Required. The ID of the DeployedModel to be undeployed from the Endpoint. |
trafficSplit | Map<String,Integer> If this field is provided, then the Endpoint's traffic_split will be overwritten with it. If last DeployedModel is being undeployed from the Endpoint, the [Endpoint.traffic_split] will always end up empty when this call returns. A DeployedModel will be successfully undeployed only if it doesn't have any traffic assigned to it when this method executes, or if this field unassigns any traffic to it. |
Type | Description |
OperationFuture<UndeployModelResponse,UndeployModelOperationMetadata> |
undeployModelCallable()
public final UnaryCallable<UndeployModelRequest,Operation> undeployModelCallable()
Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
UndeployModelRequest request =
UndeployModelRequest.newBuilder()
.setEndpoint(EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]").toString())
.setDeployedModelId("deployedModelId-1817547906")
.putAllTrafficSplit(new HashMap<String, Integer>())
.build();
ApiFuture<Operation> future =
endpointServiceClient.undeployModelCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<UndeployModelRequest,Operation> |
undeployModelOperationCallable()
public final OperationCallable<UndeployModelRequest,UndeployModelResponse,UndeployModelOperationMetadata> undeployModelOperationCallable()
Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
UndeployModelRequest request =
UndeployModelRequest.newBuilder()
.setEndpoint(EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]").toString())
.setDeployedModelId("deployedModelId-1817547906")
.putAllTrafficSplit(new HashMap<String, Integer>())
.build();
OperationFuture<UndeployModelResponse, UndeployModelOperationMetadata> future =
endpointServiceClient.undeployModelOperationCallable().futureCall(request);
// Do something.
UndeployModelResponse response = future.get();
}
Type | Description |
OperationCallable<UndeployModelRequest,UndeployModelResponse,UndeployModelOperationMetadata> |
updateEndpoint(Endpoint endpoint, FieldMask updateMask)
public final Endpoint updateEndpoint(Endpoint endpoint, FieldMask updateMask)
Updates an Endpoint.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
Endpoint endpoint = Endpoint.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Endpoint response = endpointServiceClient.updateEndpoint(endpoint, updateMask);
}
Name | Description |
endpoint | Endpoint Required. The Endpoint which replaces the resource on the server. |
updateMask | FieldMask Required. The update mask applies to the resource. See google.protobuf.FieldMask. |
Type | Description |
Endpoint |
updateEndpoint(UpdateEndpointRequest request)
public final Endpoint updateEndpoint(UpdateEndpointRequest request)
Updates an Endpoint.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
UpdateEndpointRequest request =
UpdateEndpointRequest.newBuilder()
.setEndpoint(Endpoint.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Endpoint response = endpointServiceClient.updateEndpoint(request);
}
Name | Description |
request | UpdateEndpointRequest The request object containing all of the parameters for the API call. |
Type | Description |
Endpoint |
updateEndpointCallable()
public final UnaryCallable<UpdateEndpointRequest,Endpoint> updateEndpointCallable()
Updates an Endpoint.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
UpdateEndpointRequest request =
UpdateEndpointRequest.newBuilder()
.setEndpoint(Endpoint.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Endpoint> future =
endpointServiceClient.updateEndpointCallable().futureCall(request);
// Do something.
Endpoint response = future.get();
}
Type | Description |
UnaryCallable<UpdateEndpointRequest,Endpoint> |