Package com.google.cloud.aiplatform.v1

Class EndpointServiceClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, AutoCloseable
    @Generated("by gapic-generator-java")
public class EndpointServiceClient
extends Object
implements com.google.api.gax.core.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 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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   EndpointName name =
       EndpointName.ofProjectLocationEndpointName("[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:

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

    See the individual methods for example code.

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

    This class can be customized by passing in a custom instance of EndpointServiceSettings 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
 EndpointServiceSettings endpointServiceSettings =
     EndpointServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 EndpointServiceClient endpointServiceClient =
     EndpointServiceClient.create(endpointServiceSettings);

    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
 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.

    • Constructor Detail

      • EndpointServiceClient

        protected EndpointServiceClient​(EndpointServiceSettings settings)
                         throws IOException
        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.
        Throws:
        IOException

    • Method Detail

      • create

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

      • getOperationsClient

        public final com.google.longrunning.OperationsClient getOperationsClient()
        Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

      • createEndpointAsync

        public final com.google.api.gax.longrunning.OperationFuture<Endpoint,​CreateEndpointOperationMetadata> createEndpointAsync​(LocationName parent,
                                                                                                                                Endpoint endpoint)
        Creates an Endpoint.

        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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Endpoint endpoint = Endpoint.newBuilder().build();
   Endpoint response = endpointServiceClient.createEndpointAsync(parent, endpoint).get();
 }
        Parameters:
        parent - Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project}/locations/{location}`
        endpoint - Required. The Endpoint to create.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createEndpointAsync

        public final com.google.api.gax.longrunning.OperationFuture<Endpoint,​CreateEndpointOperationMetadata> createEndpointAsync​(String parent,
                                                                                                                                Endpoint endpoint)
        Creates an Endpoint.

        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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Endpoint endpoint = Endpoint.newBuilder().build();
   Endpoint response = endpointServiceClient.createEndpointAsync(parent, endpoint).get();
 }
        Parameters:
        parent - Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project}/locations/{location}`
        endpoint - Required. The Endpoint to create.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createEndpointAsync

        public final com.google.api.gax.longrunning.OperationFuture<Endpoint,​CreateEndpointOperationMetadata> createEndpointAsync​(LocationName parent,
                                                                                                                                Endpoint endpoint,
                                                                                                                                String endpointId)
        Creates an Endpoint.

        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 (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();
 }
        Parameters:
        parent - Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project}/locations/{location}`
        endpoint - Required. The Endpoint to create.
        endpointId - 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.

        If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number.

        If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros.

        When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body.

        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createEndpointAsync

        public final com.google.api.gax.longrunning.OperationFuture<Endpoint,​CreateEndpointOperationMetadata> createEndpointAsync​(String parent,
                                                                                                                                Endpoint endpoint,
                                                                                                                                String endpointId)
        Creates an Endpoint.

        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 (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();
 }
        Parameters:
        parent - Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project}/locations/{location}`
        endpoint - Required. The Endpoint to create.
        endpointId - 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.

        If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number.

        If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros.

        When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body.

        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createEndpointAsync

        public final com.google.api.gax.longrunning.OperationFuture<Endpoint,​CreateEndpointOperationMetadata> createEndpointAsync​(CreateEndpointRequest request)
        Creates an Endpoint.

        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 (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();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createEndpointOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<CreateEndpointRequest,​Endpoint,​CreateEndpointOperationMetadata> createEndpointOperationCallable()
        Creates an Endpoint.

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

      • createEndpointCallable

        public final com.google.api.gax.rpc.UnaryCallable<CreateEndpointRequest,​com.google.longrunning.Operation> createEndpointCallable()
        Creates an Endpoint.

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

      • getEndpoint

        public final Endpoint getEndpoint​(EndpointName name)
        Gets an Endpoint.

        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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   EndpointName name =
       EndpointName.ofProjectLocationEndpointName("[PROJECT]", "[LOCATION]", "[ENDPOINT]");
   Endpoint response = endpointServiceClient.getEndpoint(name);
 }
        Parameters:
        name - Required. The name of the Endpoint resource. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getEndpoint

        public final Endpoint getEndpoint​(String name)
        Gets an Endpoint.

        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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   String name =
       EndpointName.ofProjectLocationEndpointName("[PROJECT]", "[LOCATION]", "[ENDPOINT]")
           .toString();
   Endpoint response = endpointServiceClient.getEndpoint(name);
 }
        Parameters:
        name - Required. The name of the Endpoint resource. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getEndpoint

        public final Endpoint getEndpoint​(GetEndpointRequest request)
        Gets an Endpoint.

        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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   GetEndpointRequest request =
       GetEndpointRequest.newBuilder()
           .setName(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .build();
   Endpoint response = endpointServiceClient.getEndpoint(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getEndpointCallable

        public final com.google.api.gax.rpc.UnaryCallable<GetEndpointRequest,​Endpoint> getEndpointCallable()
        Gets an Endpoint.

        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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   GetEndpointRequest request =
       GetEndpointRequest.newBuilder()
           .setName(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .build();
   ApiFuture<Endpoint> future = endpointServiceClient.getEndpointCallable().futureCall(request);
   // Do something.
   Endpoint response = future.get();
 }

      • listEndpoints

        public final EndpointServiceClient.ListEndpointsPagedResponse listEndpoints​(LocationName parent)
        Lists Endpoints in a Location.

        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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Endpoint element : endpointServiceClient.listEndpoints(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
        Parameters:
        parent - Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project}/locations/{location}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listEndpoints

        public final EndpointServiceClient.ListEndpointsPagedResponse listEndpoints​(String parent)
        Lists Endpoints in a Location.

        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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Endpoint element : endpointServiceClient.listEndpoints(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
        Parameters:
        parent - Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project}/locations/{location}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listEndpoints

        public final EndpointServiceClient.ListEndpointsPagedResponse listEndpoints​(ListEndpointsRequest request)
        Lists Endpoints in a Location.

        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 (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);
   }
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listEndpointsPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListEndpointsRequest,​EndpointServiceClient.ListEndpointsPagedResponse> listEndpointsPagedCallable()
        Lists Endpoints in a Location.

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

      • listEndpointsCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListEndpointsRequest,​ListEndpointsResponse> listEndpointsCallable()
        Lists Endpoints in a Location.

        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 (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;
     }
   }
 }

      • updateEndpoint

        public final Endpoint updateEndpoint​(Endpoint endpoint,
                                     com.google.protobuf.FieldMask updateMask)
        Updates an Endpoint.

        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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   Endpoint endpoint = Endpoint.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Endpoint response = endpointServiceClient.updateEndpoint(endpoint, updateMask);
 }
        Parameters:
        endpoint - Required. The Endpoint which replaces the resource on the server.
        updateMask - Required. The update mask applies to the resource. See [google.protobuf.FieldMask][google.protobuf.FieldMask].
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • updateEndpoint

        public final Endpoint updateEndpoint​(UpdateEndpointRequest request)
        Updates an Endpoint.

        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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   UpdateEndpointRequest request =
       UpdateEndpointRequest.newBuilder()
           .setEndpoint(Endpoint.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Endpoint response = endpointServiceClient.updateEndpoint(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • updateEndpointCallable

        public final com.google.api.gax.rpc.UnaryCallable<UpdateEndpointRequest,​Endpoint> updateEndpointCallable()
        Updates an Endpoint.

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

      • deleteEndpointAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​DeleteOperationMetadata> deleteEndpointAsync​(EndpointName name)
        Deletes an Endpoint.

        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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   EndpointName name =
       EndpointName.ofProjectLocationEndpointName("[PROJECT]", "[LOCATION]", "[ENDPOINT]");
   endpointServiceClient.deleteEndpointAsync(name).get();
 }
        Parameters:
        name - Required. The name of the Endpoint resource to be deleted. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteEndpointAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​DeleteOperationMetadata> deleteEndpointAsync​(String name)
        Deletes an Endpoint.

        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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   String name =
       EndpointName.ofProjectLocationEndpointName("[PROJECT]", "[LOCATION]", "[ENDPOINT]")
           .toString();
   endpointServiceClient.deleteEndpointAsync(name).get();
 }
        Parameters:
        name - Required. The name of the Endpoint resource to be deleted. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteEndpointAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​DeleteOperationMetadata> deleteEndpointAsync​(DeleteEndpointRequest request)
        Deletes an Endpoint.

        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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   DeleteEndpointRequest request =
       DeleteEndpointRequest.newBuilder()
           .setName(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .build();
   endpointServiceClient.deleteEndpointAsync(request).get();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteEndpointOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<DeleteEndpointRequest,​com.google.protobuf.Empty,​DeleteOperationMetadata> deleteEndpointOperationCallable()
        Deletes an Endpoint.

        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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   DeleteEndpointRequest request =
       DeleteEndpointRequest.newBuilder()
           .setName(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       endpointServiceClient.deleteEndpointOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

      • deleteEndpointCallable

        public final com.google.api.gax.rpc.UnaryCallable<DeleteEndpointRequest,​com.google.longrunning.Operation> deleteEndpointCallable()
        Deletes an Endpoint.

        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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   DeleteEndpointRequest request =
       DeleteEndpointRequest.newBuilder()
           .setName(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       endpointServiceClient.deleteEndpointCallable().futureCall(request);
   // Do something.
   future.get();
 }

      • deployModelAsync

        public final com.google.api.gax.longrunning.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 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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   EndpointName endpoint =
       EndpointName.ofProjectLocationEndpointName("[PROJECT]", "[LOCATION]", "[ENDPOINT]");
   DeployedModel deployedModel = DeployedModel.newBuilder().build();
   Map<String, Integer> trafficSplit = new HashMap<>();
   DeployModelResponse response =
       endpointServiceClient.deployModelAsync(endpoint, deployedModel, trafficSplit).get();
 }
        Parameters:
        endpoint - Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
        deployedModel - Required. The DeployedModel to be created within the Endpoint. Note that [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] must be updated for the DeployedModel to start receiving traffic, either as part of this call, or via [EndpointService.UpdateEndpoint][google.cloud.aiplatform.v1.EndpointService.UpdateEndpoint].
        trafficSplit - 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][google.cloud.aiplatform.v1.Endpoint.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][google.cloud.aiplatform.v1.Endpoint.traffic_split] is not updated.

        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deployModelAsync

        public final com.google.api.gax.longrunning.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 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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   String endpoint =
       EndpointName.ofProjectLocationEndpointName("[PROJECT]", "[LOCATION]", "[ENDPOINT]")
           .toString();
   DeployedModel deployedModel = DeployedModel.newBuilder().build();
   Map<String, Integer> trafficSplit = new HashMap<>();
   DeployModelResponse response =
       endpointServiceClient.deployModelAsync(endpoint, deployedModel, trafficSplit).get();
 }
        Parameters:
        endpoint - Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
        deployedModel - Required. The DeployedModel to be created within the Endpoint. Note that [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] must be updated for the DeployedModel to start receiving traffic, either as part of this call, or via [EndpointService.UpdateEndpoint][google.cloud.aiplatform.v1.EndpointService.UpdateEndpoint].
        trafficSplit - 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][google.cloud.aiplatform.v1.Endpoint.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][google.cloud.aiplatform.v1.Endpoint.traffic_split] is not updated.

        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deployModelAsync

        public final com.google.api.gax.longrunning.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 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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   DeployModelRequest request =
       DeployModelRequest.newBuilder()
           .setEndpoint(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setDeployedModel(DeployedModel.newBuilder().build())
           .putAllTrafficSplit(new HashMap<String, Integer>())
           .build();
   DeployModelResponse response = endpointServiceClient.deployModelAsync(request).get();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deployModelOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<DeployModelRequest,​DeployModelResponse,​DeployModelOperationMetadata> deployModelOperationCallable()
        Deploys a Model into this Endpoint, creating a DeployedModel within it.

        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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   DeployModelRequest request =
       DeployModelRequest.newBuilder()
           .setEndpoint(
               EndpointName.ofProjectLocationEndpointName(
                       "[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();
 }

      • deployModelCallable

        public final com.google.api.gax.rpc.UnaryCallable<DeployModelRequest,​com.google.longrunning.Operation> deployModelCallable()
        Deploys a Model into this Endpoint, creating a DeployedModel within it.

        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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   DeployModelRequest request =
       DeployModelRequest.newBuilder()
           .setEndpoint(
               EndpointName.ofProjectLocationEndpointName(
                       "[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();
 }

      • undeployModelAsync

        public final com.google.api.gax.longrunning.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 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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   EndpointName endpoint =
       EndpointName.ofProjectLocationEndpointName("[PROJECT]", "[LOCATION]", "[ENDPOINT]");
   String deployedModelId = "deployedModelId-1817547906";
   Map<String, Integer> trafficSplit = new HashMap<>();
   UndeployModelResponse response =
       endpointServiceClient.undeployModelAsync(endpoint, deployedModelId, trafficSplit).get();
 }
        Parameters:
        endpoint - Required. The name of the Endpoint resource from which to undeploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
        deployedModelId - Required. The ID of the DeployedModel to be undeployed from the Endpoint.
        trafficSplit - If this field is provided, then the Endpoint's [traffic_split][google.cloud.aiplatform.v1.Endpoint.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.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • undeployModelAsync

        public final com.google.api.gax.longrunning.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 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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   String endpoint =
       EndpointName.ofProjectLocationEndpointName("[PROJECT]", "[LOCATION]", "[ENDPOINT]")
           .toString();
   String deployedModelId = "deployedModelId-1817547906";
   Map<String, Integer> trafficSplit = new HashMap<>();
   UndeployModelResponse response =
       endpointServiceClient.undeployModelAsync(endpoint, deployedModelId, trafficSplit).get();
 }
        Parameters:
        endpoint - Required. The name of the Endpoint resource from which to undeploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
        deployedModelId - Required. The ID of the DeployedModel to be undeployed from the Endpoint.
        trafficSplit - If this field is provided, then the Endpoint's [traffic_split][google.cloud.aiplatform.v1.Endpoint.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.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • undeployModelAsync

        public final com.google.api.gax.longrunning.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 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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   UndeployModelRequest request =
       UndeployModelRequest.newBuilder()
           .setEndpoint(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setDeployedModelId("deployedModelId-1817547906")
           .putAllTrafficSplit(new HashMap<String, Integer>())
           .build();
   UndeployModelResponse response = endpointServiceClient.undeployModelAsync(request).get();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • undeployModelOperationCallable

        public final com.google.api.gax.rpc.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 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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   UndeployModelRequest request =
       UndeployModelRequest.newBuilder()
           .setEndpoint(
               EndpointName.ofProjectLocationEndpointName(
                       "[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();
 }

      • undeployModelCallable

        public final com.google.api.gax.rpc.UnaryCallable<UndeployModelRequest,​com.google.longrunning.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 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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   UndeployModelRequest request =
       UndeployModelRequest.newBuilder()
           .setEndpoint(
               EndpointName.ofProjectLocationEndpointName(
                       "[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();
 }

      • mutateDeployedModelAsync

        public final com.google.api.gax.longrunning.OperationFuture<MutateDeployedModelResponse,​MutateDeployedModelOperationMetadata> mutateDeployedModelAsync​(EndpointName endpoint,
                                                                                                                                                             DeployedModel deployedModel,
                                                                                                                                                             com.google.protobuf.FieldMask updateMask)
        Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).

        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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   EndpointName endpoint =
       EndpointName.ofProjectLocationEndpointName("[PROJECT]", "[LOCATION]", "[ENDPOINT]");
   DeployedModel deployedModel = DeployedModel.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   MutateDeployedModelResponse response =
       endpointServiceClient.mutateDeployedModelAsync(endpoint, deployedModel, updateMask).get();
 }
        Parameters:
        endpoint - Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
        deployedModel - Required. The DeployedModel to be mutated within the Endpoint. Only the following fields can be mutated:
        • `min_replica_count` in either [DedicatedResources][google.cloud.aiplatform.v1.DedicatedResources] or [AutomaticResources][google.cloud.aiplatform.v1.AutomaticResources]
        • `max_replica_count` in either [DedicatedResources][google.cloud.aiplatform.v1.DedicatedResources] or [AutomaticResources][google.cloud.aiplatform.v1.AutomaticResources]
        • [autoscaling_metric_specs][google.cloud.aiplatform.v1.DedicatedResources.autoscaling_metric_specs]
        • `disable_container_logging` (v1 only)
        • `enable_container_logging` (v1beta1 only)
        updateMask - Required. The update mask applies to the resource. See [google.protobuf.FieldMask][google.protobuf.FieldMask].
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • mutateDeployedModelAsync

        public final com.google.api.gax.longrunning.OperationFuture<MutateDeployedModelResponse,​MutateDeployedModelOperationMetadata> mutateDeployedModelAsync​(String endpoint,
                                                                                                                                                             DeployedModel deployedModel,
                                                                                                                                                             com.google.protobuf.FieldMask updateMask)
        Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).

        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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   String endpoint =
       EndpointName.ofProjectLocationEndpointName("[PROJECT]", "[LOCATION]", "[ENDPOINT]")
           .toString();
   DeployedModel deployedModel = DeployedModel.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   MutateDeployedModelResponse response =
       endpointServiceClient.mutateDeployedModelAsync(endpoint, deployedModel, updateMask).get();
 }
        Parameters:
        endpoint - Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
        deployedModel - Required. The DeployedModel to be mutated within the Endpoint. Only the following fields can be mutated:
        • `min_replica_count` in either [DedicatedResources][google.cloud.aiplatform.v1.DedicatedResources] or [AutomaticResources][google.cloud.aiplatform.v1.AutomaticResources]
        • `max_replica_count` in either [DedicatedResources][google.cloud.aiplatform.v1.DedicatedResources] or [AutomaticResources][google.cloud.aiplatform.v1.AutomaticResources]
        • [autoscaling_metric_specs][google.cloud.aiplatform.v1.DedicatedResources.autoscaling_metric_specs]
        • `disable_container_logging` (v1 only)
        • `enable_container_logging` (v1beta1 only)
        updateMask - Required. The update mask applies to the resource. See [google.protobuf.FieldMask][google.protobuf.FieldMask].
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • mutateDeployedModelAsync

        public final com.google.api.gax.longrunning.OperationFuture<MutateDeployedModelResponse,​MutateDeployedModelOperationMetadata> mutateDeployedModelAsync​(MutateDeployedModelRequest request)
        Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).

        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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   MutateDeployedModelRequest request =
       MutateDeployedModelRequest.newBuilder()
           .setEndpoint(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setDeployedModel(DeployedModel.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   MutateDeployedModelResponse response =
       endpointServiceClient.mutateDeployedModelAsync(request).get();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • mutateDeployedModelOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<MutateDeployedModelRequest,​MutateDeployedModelResponse,​MutateDeployedModelOperationMetadata> mutateDeployedModelOperationCallable()
        Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).

        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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   MutateDeployedModelRequest request =
       MutateDeployedModelRequest.newBuilder()
           .setEndpoint(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setDeployedModel(DeployedModel.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<MutateDeployedModelResponse, MutateDeployedModelOperationMetadata> future =
       endpointServiceClient.mutateDeployedModelOperationCallable().futureCall(request);
   // Do something.
   MutateDeployedModelResponse response = future.get();
 }

      • mutateDeployedModelCallable

        public final com.google.api.gax.rpc.UnaryCallable<MutateDeployedModelRequest,​com.google.longrunning.Operation> mutateDeployedModelCallable()
        Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).

        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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   MutateDeployedModelRequest request =
       MutateDeployedModelRequest.newBuilder()
           .setEndpoint(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setDeployedModel(DeployedModel.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       endpointServiceClient.mutateDeployedModelCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

      • listLocations

        public final EndpointServiceClient.ListLocationsPagedResponse listLocations​(com.google.cloud.location.ListLocationsRequest request)
        Lists information about the supported locations for this service.

        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 (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);
   }
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listLocationsPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,​EndpointServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()
        Lists information about the supported locations for this service.

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

      • listLocationsCallable

        public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,​com.google.cloud.location.ListLocationsResponse> listLocationsCallable()
        Lists information about the supported locations for this service.

        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 (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;
     }
   }
 }

      • getLocation

        public final com.google.cloud.location.Location getLocation​(com.google.cloud.location.GetLocationRequest request)
        Gets information about a location.

        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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = endpointServiceClient.getLocation(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getLocationCallable

        public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,​com.google.cloud.location.Location> getLocationCallable()
        Gets information about a location.

        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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = endpointServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }

      • setIamPolicy

        public final com.google.iam.v1.Policy setIamPolicy​(com.google.iam.v1.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 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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = endpointServiceClient.setIamPolicy(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • setIamPolicyCallable

        public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,​com.google.iam.v1.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 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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future = endpointServiceClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

      • getIamPolicy

        public final com.google.iam.v1.Policy getIamPolicy​(com.google.iam.v1.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 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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = endpointServiceClient.getIamPolicy(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getIamPolicyCallable

        public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,​com.google.iam.v1.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 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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future = endpointServiceClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

      • testIamPermissions

        public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions​(com.google.iam.v1.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 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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = endpointServiceClient.testIamPermissions(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • testIamPermissionsCallable

        public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,​com.google.iam.v1.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 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 (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       endpointServiceClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }

      • shutdown

        public void shutdown()
        Specified by:
        shutdown in interface com.google.api.gax.core.BackgroundResource

      • isShutdown

        public boolean isShutdown()
        Specified by:
        isShutdown in interface com.google.api.gax.core.BackgroundResource

      • isTerminated

        public boolean isTerminated()
        Specified by:
        isTerminated in interface com.google.api.gax.core.BackgroundResource

      • shutdownNow

        public void shutdownNow()
        Specified by:
        shutdownNow in interface com.google.api.gax.core.BackgroundResource