Class DataformClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, AutoCloseable

    @BetaApi
    @Generated("by gapic-generator-java")
    public class DataformClient
    extends Object
    implements com.google.api.gax.core.BackgroundResource
    Service Description: Dataform is a service to develop, create, document, test, and update curated tables in BigQuery.

    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 (DataformClient dataformClient = DataformClient.create()) {
       RepositoryName name = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
       Repository response = dataformClient.getRepository(name);
     }
     

    Note: close() needs to be called on the DataformClient 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 DataformSettings 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
     DataformSettings dataformSettings =
         DataformSettings.newBuilder()
             .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
             .build();
     DataformClient dataformClient = DataformClient.create(dataformSettings);
     

    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
     DataformSettings dataformSettings =
         DataformSettings.newBuilder().setEndpoint(myEndpoint).build();
     DataformClient dataformClient = DataformClient.create(dataformSettings);
     

    To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:

    
     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     DataformSettings dataformSettings = DataformSettings.newHttpJsonBuilder().build();
     DataformClient dataformClient = DataformClient.create(dataformSettings);
     

    Please refer to the GitHub repository's samples for more quickstart code snippets.

    • Constructor Detail

      • DataformClient

        protected DataformClient​(DataformSettings settings)
                          throws IOException
        Constructs an instance of DataformClient, 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
      • DataformClient

        protected DataformClient​(DataformStub stub)
    • Method Detail

      • create

        public static final DataformClient create​(DataformSettings settings)
                                           throws IOException
        Constructs an instance of DataformClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
        Throws:
        IOException
      • create

        public static final DataformClient create​(DataformStub stub)
        Constructs an instance of DataformClient, using the given stub for making calls. This is for advanced usage - prefer using create(DataformSettings).
      • listRepositories

        public final DataformClient.ListRepositoriesPagedResponse listRepositories​(LocationName parent)
        Lists Repositories in a given project and 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 (DataformClient dataformClient = DataformClient.create()) {
           LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
           for (Repository element : dataformClient.listRepositories(parent).iterateAll()) {
             // doThingsWith(element);
           }
         }
         
        Parameters:
        parent - Required. The location in which to list repositories. Must be in the format `projects/*/locations/*`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • listRepositories

        public final DataformClient.ListRepositoriesPagedResponse listRepositories​(String parent)
        Lists Repositories in a given project and 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 (DataformClient dataformClient = DataformClient.create()) {
           String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
           for (Repository element : dataformClient.listRepositories(parent).iterateAll()) {
             // doThingsWith(element);
           }
         }
         
        Parameters:
        parent - Required. The location in which to list repositories. Must be in the format `projects/*/locations/*`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • listRepositories

        public final DataformClient.ListRepositoriesPagedResponse listRepositories​(ListRepositoriesRequest request)
        Lists Repositories in a given project and 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 (DataformClient dataformClient = DataformClient.create()) {
           ListRepositoriesRequest request =
               ListRepositoriesRequest.newBuilder()
                   .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .setOrderBy("orderBy-1207110587")
                   .setFilter("filter-1274492040")
                   .build();
           for (Repository element : dataformClient.listRepositories(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
      • listRepositoriesPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListRepositoriesRequest,​DataformClient.ListRepositoriesPagedResponse> listRepositoriesPagedCallable()
        Lists Repositories in a given project and 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 (DataformClient dataformClient = DataformClient.create()) {
           ListRepositoriesRequest request =
               ListRepositoriesRequest.newBuilder()
                   .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .setOrderBy("orderBy-1207110587")
                   .setFilter("filter-1274492040")
                   .build();
           ApiFuture<Repository> future =
               dataformClient.listRepositoriesPagedCallable().futureCall(request);
           // Do something.
           for (Repository element : future.get().iterateAll()) {
             // doThingsWith(element);
           }
         }
         
      • listRepositoriesCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListRepositoriesRequest,​ListRepositoriesResponse> listRepositoriesCallable()
        Lists Repositories in a given project and 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 (DataformClient dataformClient = DataformClient.create()) {
           ListRepositoriesRequest request =
               ListRepositoriesRequest.newBuilder()
                   .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .setOrderBy("orderBy-1207110587")
                   .setFilter("filter-1274492040")
                   .build();
           while (true) {
             ListRepositoriesResponse response = dataformClient.listRepositoriesCallable().call(request);
             for (Repository element : response.getRepositoriesList()) {
               // doThingsWith(element);
             }
             String nextPageToken = response.getNextPageToken();
             if (!Strings.isNullOrEmpty(nextPageToken)) {
               request = request.toBuilder().setPageToken(nextPageToken).build();
             } else {
               break;
             }
           }
         }
         
      • getRepository

        public final Repository getRepository​(RepositoryName name)
        Fetches a single Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           RepositoryName name = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
           Repository response = dataformClient.getRepository(name);
         }
         
        Parameters:
        name - Required. The repository's name.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • getRepository

        public final Repository getRepository​(String name)
        Fetches a single Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           String name = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString();
           Repository response = dataformClient.getRepository(name);
         }
         
        Parameters:
        name - Required. The repository's name.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • getRepository

        public final Repository getRepository​(GetRepositoryRequest request)
        Fetches a single Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           GetRepositoryRequest request =
               GetRepositoryRequest.newBuilder()
                   .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
                   .build();
           Repository response = dataformClient.getRepository(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
      • getRepositoryCallable

        public final com.google.api.gax.rpc.UnaryCallable<GetRepositoryRequest,​Repository> getRepositoryCallable()
        Fetches a single Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           GetRepositoryRequest request =
               GetRepositoryRequest.newBuilder()
                   .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
                   .build();
           ApiFuture<Repository> future = dataformClient.getRepositoryCallable().futureCall(request);
           // Do something.
           Repository response = future.get();
         }
         
      • createRepository

        public final Repository createRepository​(LocationName parent,
                                                 Repository repository,
                                                 String repositoryId)
        Creates a new Repository in a given project and 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 (DataformClient dataformClient = DataformClient.create()) {
           LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
           Repository repository = Repository.newBuilder().build();
           String repositoryId = "repositoryId2113747461";
           Repository response = dataformClient.createRepository(parent, repository, repositoryId);
         }
         
        Parameters:
        parent - Required. The location in which to create the repository. Must be in the format `projects/*/locations/*`.
        repository - Required. The repository to create.
        repositoryId - Required. The ID to use for the repository, which will become the final component of the repository's resource name.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • createRepository

        public final Repository createRepository​(String parent,
                                                 Repository repository,
                                                 String repositoryId)
        Creates a new Repository in a given project and 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 (DataformClient dataformClient = DataformClient.create()) {
           String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
           Repository repository = Repository.newBuilder().build();
           String repositoryId = "repositoryId2113747461";
           Repository response = dataformClient.createRepository(parent, repository, repositoryId);
         }
         
        Parameters:
        parent - Required. The location in which to create the repository. Must be in the format `projects/*/locations/*`.
        repository - Required. The repository to create.
        repositoryId - Required. The ID to use for the repository, which will become the final component of the repository's resource name.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • createRepository

        public final Repository createRepository​(CreateRepositoryRequest request)
        Creates a new Repository in a given project and 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 (DataformClient dataformClient = DataformClient.create()) {
           CreateRepositoryRequest request =
               CreateRepositoryRequest.newBuilder()
                   .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                   .setRepository(Repository.newBuilder().build())
                   .setRepositoryId("repositoryId2113747461")
                   .build();
           Repository response = dataformClient.createRepository(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
      • createRepositoryCallable

        public final com.google.api.gax.rpc.UnaryCallable<CreateRepositoryRequest,​Repository> createRepositoryCallable()
        Creates a new Repository in a given project and 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 (DataformClient dataformClient = DataformClient.create()) {
           CreateRepositoryRequest request =
               CreateRepositoryRequest.newBuilder()
                   .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                   .setRepository(Repository.newBuilder().build())
                   .setRepositoryId("repositoryId2113747461")
                   .build();
           ApiFuture<Repository> future = dataformClient.createRepositoryCallable().futureCall(request);
           // Do something.
           Repository response = future.get();
         }
         
      • updateRepository

        public final Repository updateRepository​(Repository repository,
                                                 com.google.protobuf.FieldMask updateMask)
        Updates a single Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           Repository repository = Repository.newBuilder().build();
           FieldMask updateMask = FieldMask.newBuilder().build();
           Repository response = dataformClient.updateRepository(repository, updateMask);
         }
         
        Parameters:
        repository - Required. The repository to update.
        updateMask - Optional. Specifies the fields to be updated in the repository. If left unset, all fields will be updated.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • updateRepository

        public final Repository updateRepository​(UpdateRepositoryRequest request)
        Updates a single Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           UpdateRepositoryRequest request =
               UpdateRepositoryRequest.newBuilder()
                   .setUpdateMask(FieldMask.newBuilder().build())
                   .setRepository(Repository.newBuilder().build())
                   .build();
           Repository response = dataformClient.updateRepository(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
      • updateRepositoryCallable

        public final com.google.api.gax.rpc.UnaryCallable<UpdateRepositoryRequest,​Repository> updateRepositoryCallable()
        Updates a single Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           UpdateRepositoryRequest request =
               UpdateRepositoryRequest.newBuilder()
                   .setUpdateMask(FieldMask.newBuilder().build())
                   .setRepository(Repository.newBuilder().build())
                   .build();
           ApiFuture<Repository> future = dataformClient.updateRepositoryCallable().futureCall(request);
           // Do something.
           Repository response = future.get();
         }
         
      • deleteRepository

        public final void deleteRepository​(RepositoryName name)
        Deletes a single Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           RepositoryName name = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
           dataformClient.deleteRepository(name);
         }
         
        Parameters:
        name - Required. The repository's name.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • deleteRepository

        public final void deleteRepository​(String name)
        Deletes a single Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           String name = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString();
           dataformClient.deleteRepository(name);
         }
         
        Parameters:
        name - Required. The repository's name.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • deleteRepository

        public final void deleteRepository​(DeleteRepositoryRequest request)
        Deletes a single Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           DeleteRepositoryRequest request =
               DeleteRepositoryRequest.newBuilder()
                   .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
                   .setForce(true)
                   .build();
           dataformClient.deleteRepository(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
      • deleteRepositoryCallable

        public final com.google.api.gax.rpc.UnaryCallable<DeleteRepositoryRequest,​com.google.protobuf.Empty> deleteRepositoryCallable()
        Deletes a single Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           DeleteRepositoryRequest request =
               DeleteRepositoryRequest.newBuilder()
                   .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
                   .setForce(true)
                   .build();
           ApiFuture<Empty> future = dataformClient.deleteRepositoryCallable().futureCall(request);
           // Do something.
           future.get();
         }
         
      • fetchRemoteBranches

        public final FetchRemoteBranchesResponse fetchRemoteBranches​(FetchRemoteBranchesRequest request)
        Fetches a Repository's remote branches.

        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 (DataformClient dataformClient = DataformClient.create()) {
           FetchRemoteBranchesRequest request =
               FetchRemoteBranchesRequest.newBuilder()
                   .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
                   .build();
           FetchRemoteBranchesResponse response = dataformClient.fetchRemoteBranches(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
      • fetchRemoteBranchesCallable

        public final com.google.api.gax.rpc.UnaryCallable<FetchRemoteBranchesRequest,​FetchRemoteBranchesResponse> fetchRemoteBranchesCallable()
        Fetches a Repository's remote branches.

        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 (DataformClient dataformClient = DataformClient.create()) {
           FetchRemoteBranchesRequest request =
               FetchRemoteBranchesRequest.newBuilder()
                   .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
                   .build();
           ApiFuture<FetchRemoteBranchesResponse> future =
               dataformClient.fetchRemoteBranchesCallable().futureCall(request);
           // Do something.
           FetchRemoteBranchesResponse response = future.get();
         }
         
      • listWorkspaces

        public final DataformClient.ListWorkspacesPagedResponse listWorkspaces​(RepositoryName parent)
        Lists Workspaces in a given Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           RepositoryName parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
           for (Workspace element : dataformClient.listWorkspaces(parent).iterateAll()) {
             // doThingsWith(element);
           }
         }
         
        Parameters:
        parent - Required. The repository in which to list workspaces. Must be in the format `projects/*/locations/*/repositories/*`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • listWorkspaces

        public final DataformClient.ListWorkspacesPagedResponse listWorkspaces​(String parent)
        Lists Workspaces in a given Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           String parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString();
           for (Workspace element : dataformClient.listWorkspaces(parent).iterateAll()) {
             // doThingsWith(element);
           }
         }
         
        Parameters:
        parent - Required. The repository in which to list workspaces. Must be in the format `projects/*/locations/*/repositories/*`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • listWorkspaces

        public final DataformClient.ListWorkspacesPagedResponse listWorkspaces​(ListWorkspacesRequest request)
        Lists Workspaces in a given Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           ListWorkspacesRequest request =
               ListWorkspacesRequest.newBuilder()
                   .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .setOrderBy("orderBy-1207110587")
                   .setFilter("filter-1274492040")
                   .build();
           for (Workspace element : dataformClient.listWorkspaces(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
      • listWorkspacesPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListWorkspacesRequest,​DataformClient.ListWorkspacesPagedResponse> listWorkspacesPagedCallable()
        Lists Workspaces in a given Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           ListWorkspacesRequest request =
               ListWorkspacesRequest.newBuilder()
                   .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .setOrderBy("orderBy-1207110587")
                   .setFilter("filter-1274492040")
                   .build();
           ApiFuture<Workspace> future =
               dataformClient.listWorkspacesPagedCallable().futureCall(request);
           // Do something.
           for (Workspace element : future.get().iterateAll()) {
             // doThingsWith(element);
           }
         }
         
      • listWorkspacesCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListWorkspacesRequest,​ListWorkspacesResponse> listWorkspacesCallable()
        Lists Workspaces in a given Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           ListWorkspacesRequest request =
               ListWorkspacesRequest.newBuilder()
                   .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .setOrderBy("orderBy-1207110587")
                   .setFilter("filter-1274492040")
                   .build();
           while (true) {
             ListWorkspacesResponse response = dataformClient.listWorkspacesCallable().call(request);
             for (Workspace element : response.getWorkspacesList()) {
               // doThingsWith(element);
             }
             String nextPageToken = response.getNextPageToken();
             if (!Strings.isNullOrEmpty(nextPageToken)) {
               request = request.toBuilder().setPageToken(nextPageToken).build();
             } else {
               break;
             }
           }
         }
         
      • getWorkspace

        public final Workspace getWorkspace​(WorkspaceName name)
        Fetches a single Workspace.

        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 (DataformClient dataformClient = DataformClient.create()) {
           WorkspaceName name =
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]");
           Workspace response = dataformClient.getWorkspace(name);
         }
         
        Parameters:
        name - Required. The workspace's name.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • getWorkspace

        public final Workspace getWorkspace​(String name)
        Fetches a single Workspace.

        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 (DataformClient dataformClient = DataformClient.create()) {
           String name =
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]").toString();
           Workspace response = dataformClient.getWorkspace(name);
         }
         
        Parameters:
        name - Required. The workspace's name.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • getWorkspace

        public final Workspace getWorkspace​(GetWorkspaceRequest request)
        Fetches a single Workspace.

        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 (DataformClient dataformClient = DataformClient.create()) {
           GetWorkspaceRequest request =
               GetWorkspaceRequest.newBuilder()
                   .setName(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .build();
           Workspace response = dataformClient.getWorkspace(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
      • getWorkspaceCallable

        public final com.google.api.gax.rpc.UnaryCallable<GetWorkspaceRequest,​Workspace> getWorkspaceCallable()
        Fetches a single Workspace.

        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 (DataformClient dataformClient = DataformClient.create()) {
           GetWorkspaceRequest request =
               GetWorkspaceRequest.newBuilder()
                   .setName(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .build();
           ApiFuture<Workspace> future = dataformClient.getWorkspaceCallable().futureCall(request);
           // Do something.
           Workspace response = future.get();
         }
         
      • createWorkspace

        public final Workspace createWorkspace​(RepositoryName parent,
                                               Workspace workspace,
                                               String workspaceId)
        Creates a new Workspace in a given Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           RepositoryName parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
           Workspace workspace = Workspace.newBuilder().build();
           String workspaceId = "workspaceId466560144";
           Workspace response = dataformClient.createWorkspace(parent, workspace, workspaceId);
         }
         
        Parameters:
        parent - Required. The repository in which to create the workspace. Must be in the format `projects/*/locations/*/repositories/*`.
        workspace - Required. The workspace to create.
        workspaceId - Required. The ID to use for the workspace, which will become the final component of the workspace's resource name.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • createWorkspace

        public final Workspace createWorkspace​(String parent,
                                               Workspace workspace,
                                               String workspaceId)
        Creates a new Workspace in a given Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           String parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString();
           Workspace workspace = Workspace.newBuilder().build();
           String workspaceId = "workspaceId466560144";
           Workspace response = dataformClient.createWorkspace(parent, workspace, workspaceId);
         }
         
        Parameters:
        parent - Required. The repository in which to create the workspace. Must be in the format `projects/*/locations/*/repositories/*`.
        workspace - Required. The workspace to create.
        workspaceId - Required. The ID to use for the workspace, which will become the final component of the workspace's resource name.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • createWorkspace

        public final Workspace createWorkspace​(CreateWorkspaceRequest request)
        Creates a new Workspace in a given Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           CreateWorkspaceRequest request =
               CreateWorkspaceRequest.newBuilder()
                   .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
                   .setWorkspace(Workspace.newBuilder().build())
                   .setWorkspaceId("workspaceId466560144")
                   .build();
           Workspace response = dataformClient.createWorkspace(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
      • createWorkspaceCallable

        public final com.google.api.gax.rpc.UnaryCallable<CreateWorkspaceRequest,​Workspace> createWorkspaceCallable()
        Creates a new Workspace in a given Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           CreateWorkspaceRequest request =
               CreateWorkspaceRequest.newBuilder()
                   .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
                   .setWorkspace(Workspace.newBuilder().build())
                   .setWorkspaceId("workspaceId466560144")
                   .build();
           ApiFuture<Workspace> future = dataformClient.createWorkspaceCallable().futureCall(request);
           // Do something.
           Workspace response = future.get();
         }
         
      • deleteWorkspace

        public final void deleteWorkspace​(WorkspaceName name)
        Deletes a single Workspace.

        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 (DataformClient dataformClient = DataformClient.create()) {
           WorkspaceName name =
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]");
           dataformClient.deleteWorkspace(name);
         }
         
        Parameters:
        name - Required. The workspace resource's name.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • deleteWorkspace

        public final void deleteWorkspace​(String name)
        Deletes a single Workspace.

        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 (DataformClient dataformClient = DataformClient.create()) {
           String name =
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]").toString();
           dataformClient.deleteWorkspace(name);
         }
         
        Parameters:
        name - Required. The workspace resource's name.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • deleteWorkspace

        public final void deleteWorkspace​(DeleteWorkspaceRequest request)
        Deletes a single Workspace.

        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 (DataformClient dataformClient = DataformClient.create()) {
           DeleteWorkspaceRequest request =
               DeleteWorkspaceRequest.newBuilder()
                   .setName(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .build();
           dataformClient.deleteWorkspace(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
      • deleteWorkspaceCallable

        public final com.google.api.gax.rpc.UnaryCallable<DeleteWorkspaceRequest,​com.google.protobuf.Empty> deleteWorkspaceCallable()
        Deletes a single Workspace.

        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 (DataformClient dataformClient = DataformClient.create()) {
           DeleteWorkspaceRequest request =
               DeleteWorkspaceRequest.newBuilder()
                   .setName(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .build();
           ApiFuture<Empty> future = dataformClient.deleteWorkspaceCallable().futureCall(request);
           // Do something.
           future.get();
         }
         
      • installNpmPackages

        public final InstallNpmPackagesResponse installNpmPackages​(InstallNpmPackagesRequest request)
        Installs dependency NPM packages (inside a Workspace).

        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 (DataformClient dataformClient = DataformClient.create()) {
           InstallNpmPackagesRequest request =
               InstallNpmPackagesRequest.newBuilder()
                   .setWorkspace(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .build();
           InstallNpmPackagesResponse response = dataformClient.installNpmPackages(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
      • installNpmPackagesCallable

        public final com.google.api.gax.rpc.UnaryCallable<InstallNpmPackagesRequest,​InstallNpmPackagesResponse> installNpmPackagesCallable()
        Installs dependency NPM packages (inside a Workspace).

        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 (DataformClient dataformClient = DataformClient.create()) {
           InstallNpmPackagesRequest request =
               InstallNpmPackagesRequest.newBuilder()
                   .setWorkspace(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .build();
           ApiFuture<InstallNpmPackagesResponse> future =
               dataformClient.installNpmPackagesCallable().futureCall(request);
           // Do something.
           InstallNpmPackagesResponse response = future.get();
         }
         
      • pullGitCommits

        public final void pullGitCommits​(PullGitCommitsRequest request)
        Pulls Git commits from the Repository's remote into a Workspace.

        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 (DataformClient dataformClient = DataformClient.create()) {
           PullGitCommitsRequest request =
               PullGitCommitsRequest.newBuilder()
                   .setName(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setRemoteBranch("remoteBranch-533119608")
                   .setAuthor(CommitAuthor.newBuilder().build())
                   .build();
           dataformClient.pullGitCommits(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
      • pullGitCommitsCallable

        public final com.google.api.gax.rpc.UnaryCallable<PullGitCommitsRequest,​com.google.protobuf.Empty> pullGitCommitsCallable()
        Pulls Git commits from the Repository's remote into a Workspace.

        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 (DataformClient dataformClient = DataformClient.create()) {
           PullGitCommitsRequest request =
               PullGitCommitsRequest.newBuilder()
                   .setName(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setRemoteBranch("remoteBranch-533119608")
                   .setAuthor(CommitAuthor.newBuilder().build())
                   .build();
           ApiFuture<Empty> future = dataformClient.pullGitCommitsCallable().futureCall(request);
           // Do something.
           future.get();
         }
         
      • pushGitCommits

        public final void pushGitCommits​(PushGitCommitsRequest request)
        Pushes Git commits from a Workspace to the Repository's remote.

        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 (DataformClient dataformClient = DataformClient.create()) {
           PushGitCommitsRequest request =
               PushGitCommitsRequest.newBuilder()
                   .setName(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setRemoteBranch("remoteBranch-533119608")
                   .build();
           dataformClient.pushGitCommits(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
      • pushGitCommitsCallable

        public final com.google.api.gax.rpc.UnaryCallable<PushGitCommitsRequest,​com.google.protobuf.Empty> pushGitCommitsCallable()
        Pushes Git commits from a Workspace to the Repository's remote.

        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 (DataformClient dataformClient = DataformClient.create()) {
           PushGitCommitsRequest request =
               PushGitCommitsRequest.newBuilder()
                   .setName(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setRemoteBranch("remoteBranch-533119608")
                   .build();
           ApiFuture<Empty> future = dataformClient.pushGitCommitsCallable().futureCall(request);
           // Do something.
           future.get();
         }
         
      • fetchFileGitStatuses

        public final FetchFileGitStatusesResponse fetchFileGitStatuses​(FetchFileGitStatusesRequest request)
        Fetches Git statuses for the files in a Workspace.

        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 (DataformClient dataformClient = DataformClient.create()) {
           FetchFileGitStatusesRequest request =
               FetchFileGitStatusesRequest.newBuilder()
                   .setName(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .build();
           FetchFileGitStatusesResponse response = dataformClient.fetchFileGitStatuses(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
      • fetchFileGitStatusesCallable

        public final com.google.api.gax.rpc.UnaryCallable<FetchFileGitStatusesRequest,​FetchFileGitStatusesResponse> fetchFileGitStatusesCallable()
        Fetches Git statuses for the files in a Workspace.

        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 (DataformClient dataformClient = DataformClient.create()) {
           FetchFileGitStatusesRequest request =
               FetchFileGitStatusesRequest.newBuilder()
                   .setName(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .build();
           ApiFuture<FetchFileGitStatusesResponse> future =
               dataformClient.fetchFileGitStatusesCallable().futureCall(request);
           // Do something.
           FetchFileGitStatusesResponse response = future.get();
         }
         
      • fetchGitAheadBehind

        public final FetchGitAheadBehindResponse fetchGitAheadBehind​(FetchGitAheadBehindRequest request)
        Fetches Git ahead/behind against a remote branch.

        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 (DataformClient dataformClient = DataformClient.create()) {
           FetchGitAheadBehindRequest request =
               FetchGitAheadBehindRequest.newBuilder()
                   .setName(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setRemoteBranch("remoteBranch-533119608")
                   .build();
           FetchGitAheadBehindResponse response = dataformClient.fetchGitAheadBehind(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
      • fetchGitAheadBehindCallable

        public final com.google.api.gax.rpc.UnaryCallable<FetchGitAheadBehindRequest,​FetchGitAheadBehindResponse> fetchGitAheadBehindCallable()
        Fetches Git ahead/behind against a remote branch.

        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 (DataformClient dataformClient = DataformClient.create()) {
           FetchGitAheadBehindRequest request =
               FetchGitAheadBehindRequest.newBuilder()
                   .setName(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setRemoteBranch("remoteBranch-533119608")
                   .build();
           ApiFuture<FetchGitAheadBehindResponse> future =
               dataformClient.fetchGitAheadBehindCallable().futureCall(request);
           // Do something.
           FetchGitAheadBehindResponse response = future.get();
         }
         
      • commitWorkspaceChanges

        public final void commitWorkspaceChanges​(CommitWorkspaceChangesRequest request)
        Applies a Git commit for uncommitted files in a Workspace.

        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 (DataformClient dataformClient = DataformClient.create()) {
           CommitWorkspaceChangesRequest request =
               CommitWorkspaceChangesRequest.newBuilder()
                   .setName(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setAuthor(CommitAuthor.newBuilder().build())
                   .setCommitMessage("commitMessage2039804624")
                   .addAllPaths(new ArrayList<String>())
                   .build();
           dataformClient.commitWorkspaceChanges(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
      • commitWorkspaceChangesCallable

        public final com.google.api.gax.rpc.UnaryCallable<CommitWorkspaceChangesRequest,​com.google.protobuf.Empty> commitWorkspaceChangesCallable()
        Applies a Git commit for uncommitted files in a Workspace.

        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 (DataformClient dataformClient = DataformClient.create()) {
           CommitWorkspaceChangesRequest request =
               CommitWorkspaceChangesRequest.newBuilder()
                   .setName(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setAuthor(CommitAuthor.newBuilder().build())
                   .setCommitMessage("commitMessage2039804624")
                   .addAllPaths(new ArrayList<String>())
                   .build();
           ApiFuture<Empty> future = dataformClient.commitWorkspaceChangesCallable().futureCall(request);
           // Do something.
           future.get();
         }
         
      • resetWorkspaceChanges

        public final void resetWorkspaceChanges​(ResetWorkspaceChangesRequest request)
        Performs a Git reset for uncommitted files in a Workspace.

        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 (DataformClient dataformClient = DataformClient.create()) {
           ResetWorkspaceChangesRequest request =
               ResetWorkspaceChangesRequest.newBuilder()
                   .setName(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .addAllPaths(new ArrayList<String>())
                   .setClean(true)
                   .build();
           dataformClient.resetWorkspaceChanges(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
      • resetWorkspaceChangesCallable

        public final com.google.api.gax.rpc.UnaryCallable<ResetWorkspaceChangesRequest,​com.google.protobuf.Empty> resetWorkspaceChangesCallable()
        Performs a Git reset for uncommitted files in a Workspace.

        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 (DataformClient dataformClient = DataformClient.create()) {
           ResetWorkspaceChangesRequest request =
               ResetWorkspaceChangesRequest.newBuilder()
                   .setName(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .addAllPaths(new ArrayList<String>())
                   .setClean(true)
                   .build();
           ApiFuture<Empty> future = dataformClient.resetWorkspaceChangesCallable().futureCall(request);
           // Do something.
           future.get();
         }
         
      • fetchFileDiff

        public final FetchFileDiffResponse fetchFileDiff​(FetchFileDiffRequest request)
        Fetches Git diff for an uncommitted file in a Workspace.

        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 (DataformClient dataformClient = DataformClient.create()) {
           FetchFileDiffRequest request =
               FetchFileDiffRequest.newBuilder()
                   .setWorkspace(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setPath("path3433509")
                   .build();
           FetchFileDiffResponse response = dataformClient.fetchFileDiff(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
      • fetchFileDiffCallable

        public final com.google.api.gax.rpc.UnaryCallable<FetchFileDiffRequest,​FetchFileDiffResponse> fetchFileDiffCallable()
        Fetches Git diff for an uncommitted file in a Workspace.

        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 (DataformClient dataformClient = DataformClient.create()) {
           FetchFileDiffRequest request =
               FetchFileDiffRequest.newBuilder()
                   .setWorkspace(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setPath("path3433509")
                   .build();
           ApiFuture<FetchFileDiffResponse> future =
               dataformClient.fetchFileDiffCallable().futureCall(request);
           // Do something.
           FetchFileDiffResponse response = future.get();
         }
         
      • queryDirectoryContents

        public final DataformClient.QueryDirectoryContentsPagedResponse queryDirectoryContents​(QueryDirectoryContentsRequest request)
        Returns the contents of a given Workspace directory.

        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 (DataformClient dataformClient = DataformClient.create()) {
           QueryDirectoryContentsRequest request =
               QueryDirectoryContentsRequest.newBuilder()
                   .setWorkspace(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setPath("path3433509")
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .build();
           for (QueryDirectoryContentsResponse.DirectoryEntry element :
               dataformClient.queryDirectoryContents(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
      • queryDirectoryContentsPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<QueryDirectoryContentsRequest,​DataformClient.QueryDirectoryContentsPagedResponse> queryDirectoryContentsPagedCallable()
        Returns the contents of a given Workspace directory.

        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 (DataformClient dataformClient = DataformClient.create()) {
           QueryDirectoryContentsRequest request =
               QueryDirectoryContentsRequest.newBuilder()
                   .setWorkspace(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setPath("path3433509")
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .build();
           ApiFuture<QueryDirectoryContentsResponse.DirectoryEntry> future =
               dataformClient.queryDirectoryContentsPagedCallable().futureCall(request);
           // Do something.
           for (QueryDirectoryContentsResponse.DirectoryEntry element : future.get().iterateAll()) {
             // doThingsWith(element);
           }
         }
         
      • queryDirectoryContentsCallable

        public final com.google.api.gax.rpc.UnaryCallable<QueryDirectoryContentsRequest,​QueryDirectoryContentsResponse> queryDirectoryContentsCallable()
        Returns the contents of a given Workspace directory.

        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 (DataformClient dataformClient = DataformClient.create()) {
           QueryDirectoryContentsRequest request =
               QueryDirectoryContentsRequest.newBuilder()
                   .setWorkspace(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setPath("path3433509")
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .build();
           while (true) {
             QueryDirectoryContentsResponse response =
                 dataformClient.queryDirectoryContentsCallable().call(request);
             for (QueryDirectoryContentsResponse.DirectoryEntry element :
                 response.getDirectoryEntriesList()) {
               // doThingsWith(element);
             }
             String nextPageToken = response.getNextPageToken();
             if (!Strings.isNullOrEmpty(nextPageToken)) {
               request = request.toBuilder().setPageToken(nextPageToken).build();
             } else {
               break;
             }
           }
         }
         
      • makeDirectory

        public final MakeDirectoryResponse makeDirectory​(MakeDirectoryRequest request)
        Creates a directory inside a Workspace.

        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 (DataformClient dataformClient = DataformClient.create()) {
           MakeDirectoryRequest request =
               MakeDirectoryRequest.newBuilder()
                   .setWorkspace(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setPath("path3433509")
                   .build();
           MakeDirectoryResponse response = dataformClient.makeDirectory(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
      • makeDirectoryCallable

        public final com.google.api.gax.rpc.UnaryCallable<MakeDirectoryRequest,​MakeDirectoryResponse> makeDirectoryCallable()
        Creates a directory inside a Workspace.

        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 (DataformClient dataformClient = DataformClient.create()) {
           MakeDirectoryRequest request =
               MakeDirectoryRequest.newBuilder()
                   .setWorkspace(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setPath("path3433509")
                   .build();
           ApiFuture<MakeDirectoryResponse> future =
               dataformClient.makeDirectoryCallable().futureCall(request);
           // Do something.
           MakeDirectoryResponse response = future.get();
         }
         
      • removeDirectory

        public final void removeDirectory​(RemoveDirectoryRequest request)
        Deletes a directory (inside a Workspace) and all of its contents.

        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 (DataformClient dataformClient = DataformClient.create()) {
           RemoveDirectoryRequest request =
               RemoveDirectoryRequest.newBuilder()
                   .setWorkspace(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setPath("path3433509")
                   .build();
           dataformClient.removeDirectory(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
      • removeDirectoryCallable

        public final com.google.api.gax.rpc.UnaryCallable<RemoveDirectoryRequest,​com.google.protobuf.Empty> removeDirectoryCallable()
        Deletes a directory (inside a Workspace) and all of its contents.

        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 (DataformClient dataformClient = DataformClient.create()) {
           RemoveDirectoryRequest request =
               RemoveDirectoryRequest.newBuilder()
                   .setWorkspace(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setPath("path3433509")
                   .build();
           ApiFuture<Empty> future = dataformClient.removeDirectoryCallable().futureCall(request);
           // Do something.
           future.get();
         }
         
      • moveDirectory

        public final MoveDirectoryResponse moveDirectory​(MoveDirectoryRequest request)
        Moves a directory (inside a Workspace), and all of its contents, to a new 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 (DataformClient dataformClient = DataformClient.create()) {
           MoveDirectoryRequest request =
               MoveDirectoryRequest.newBuilder()
                   .setWorkspace(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setPath("path3433509")
                   .setNewPath("newPath1845080549")
                   .build();
           MoveDirectoryResponse response = dataformClient.moveDirectory(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
      • moveDirectoryCallable

        public final com.google.api.gax.rpc.UnaryCallable<MoveDirectoryRequest,​MoveDirectoryResponse> moveDirectoryCallable()
        Moves a directory (inside a Workspace), and all of its contents, to a new 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 (DataformClient dataformClient = DataformClient.create()) {
           MoveDirectoryRequest request =
               MoveDirectoryRequest.newBuilder()
                   .setWorkspace(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setPath("path3433509")
                   .setNewPath("newPath1845080549")
                   .build();
           ApiFuture<MoveDirectoryResponse> future =
               dataformClient.moveDirectoryCallable().futureCall(request);
           // Do something.
           MoveDirectoryResponse response = future.get();
         }
         
      • readFile

        public final ReadFileResponse readFile​(ReadFileRequest request)
        Returns the contents of a file (inside a Workspace).

        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 (DataformClient dataformClient = DataformClient.create()) {
           ReadFileRequest request =
               ReadFileRequest.newBuilder()
                   .setWorkspace(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setPath("path3433509")
                   .build();
           ReadFileResponse response = dataformClient.readFile(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
      • readFileCallable

        public final com.google.api.gax.rpc.UnaryCallable<ReadFileRequest,​ReadFileResponse> readFileCallable()
        Returns the contents of a file (inside a Workspace).

        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 (DataformClient dataformClient = DataformClient.create()) {
           ReadFileRequest request =
               ReadFileRequest.newBuilder()
                   .setWorkspace(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setPath("path3433509")
                   .build();
           ApiFuture<ReadFileResponse> future = dataformClient.readFileCallable().futureCall(request);
           // Do something.
           ReadFileResponse response = future.get();
         }
         
      • removeFile

        public final void removeFile​(RemoveFileRequest request)
        Deletes a file (inside a Workspace).

        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 (DataformClient dataformClient = DataformClient.create()) {
           RemoveFileRequest request =
               RemoveFileRequest.newBuilder()
                   .setWorkspace(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setPath("path3433509")
                   .build();
           dataformClient.removeFile(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
      • removeFileCallable

        public final com.google.api.gax.rpc.UnaryCallable<RemoveFileRequest,​com.google.protobuf.Empty> removeFileCallable()
        Deletes a file (inside a Workspace).

        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 (DataformClient dataformClient = DataformClient.create()) {
           RemoveFileRequest request =
               RemoveFileRequest.newBuilder()
                   .setWorkspace(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setPath("path3433509")
                   .build();
           ApiFuture<Empty> future = dataformClient.removeFileCallable().futureCall(request);
           // Do something.
           future.get();
         }
         
      • moveFile

        public final MoveFileResponse moveFile​(MoveFileRequest request)
        Moves a file (inside a Workspace) to a new 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 (DataformClient dataformClient = DataformClient.create()) {
           MoveFileRequest request =
               MoveFileRequest.newBuilder()
                   .setWorkspace(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setPath("path3433509")
                   .setNewPath("newPath1845080549")
                   .build();
           MoveFileResponse response = dataformClient.moveFile(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
      • moveFileCallable

        public final com.google.api.gax.rpc.UnaryCallable<MoveFileRequest,​MoveFileResponse> moveFileCallable()
        Moves a file (inside a Workspace) to a new 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 (DataformClient dataformClient = DataformClient.create()) {
           MoveFileRequest request =
               MoveFileRequest.newBuilder()
                   .setWorkspace(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setPath("path3433509")
                   .setNewPath("newPath1845080549")
                   .build();
           ApiFuture<MoveFileResponse> future = dataformClient.moveFileCallable().futureCall(request);
           // Do something.
           MoveFileResponse response = future.get();
         }
         
      • writeFile

        public final WriteFileResponse writeFile​(WriteFileRequest request)
        Writes to a file (inside a Workspace).

        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 (DataformClient dataformClient = DataformClient.create()) {
           WriteFileRequest request =
               WriteFileRequest.newBuilder()
                   .setWorkspace(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setPath("path3433509")
                   .setContents(ByteString.EMPTY)
                   .build();
           WriteFileResponse response = dataformClient.writeFile(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
      • writeFileCallable

        public final com.google.api.gax.rpc.UnaryCallable<WriteFileRequest,​WriteFileResponse> writeFileCallable()
        Writes to a file (inside a Workspace).

        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 (DataformClient dataformClient = DataformClient.create()) {
           WriteFileRequest request =
               WriteFileRequest.newBuilder()
                   .setWorkspace(
                       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                           .toString())
                   .setPath("path3433509")
                   .setContents(ByteString.EMPTY)
                   .build();
           ApiFuture<WriteFileResponse> future = dataformClient.writeFileCallable().futureCall(request);
           // Do something.
           WriteFileResponse response = future.get();
         }
         
      • listCompilationResults

        public final DataformClient.ListCompilationResultsPagedResponse listCompilationResults​(RepositoryName parent)
        Lists CompilationResults in a given Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           RepositoryName parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
           for (CompilationResult element : dataformClient.listCompilationResults(parent).iterateAll()) {
             // doThingsWith(element);
           }
         }
         
        Parameters:
        parent - Required. The repository in which to list compilation results. Must be in the format `projects/*/locations/*/repositories/*`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • listCompilationResults

        public final DataformClient.ListCompilationResultsPagedResponse listCompilationResults​(String parent)
        Lists CompilationResults in a given Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           String parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString();
           for (CompilationResult element : dataformClient.listCompilationResults(parent).iterateAll()) {
             // doThingsWith(element);
           }
         }
         
        Parameters:
        parent - Required. The repository in which to list compilation results. Must be in the format `projects/*/locations/*/repositories/*`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • listCompilationResults

        public final DataformClient.ListCompilationResultsPagedResponse listCompilationResults​(ListCompilationResultsRequest request)
        Lists CompilationResults in a given Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           ListCompilationResultsRequest request =
               ListCompilationResultsRequest.newBuilder()
                   .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .build();
           for (CompilationResult element :
               dataformClient.listCompilationResults(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
      • listCompilationResultsPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListCompilationResultsRequest,​DataformClient.ListCompilationResultsPagedResponse> listCompilationResultsPagedCallable()
        Lists CompilationResults in a given Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           ListCompilationResultsRequest request =
               ListCompilationResultsRequest.newBuilder()
                   .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .build();
           ApiFuture<CompilationResult> future =
               dataformClient.listCompilationResultsPagedCallable().futureCall(request);
           // Do something.
           for (CompilationResult element : future.get().iterateAll()) {
             // doThingsWith(element);
           }
         }
         
      • listCompilationResultsCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListCompilationResultsRequest,​ListCompilationResultsResponse> listCompilationResultsCallable()
        Lists CompilationResults in a given Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           ListCompilationResultsRequest request =
               ListCompilationResultsRequest.newBuilder()
                   .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .build();
           while (true) {
             ListCompilationResultsResponse response =
                 dataformClient.listCompilationResultsCallable().call(request);
             for (CompilationResult element : response.getCompilationResultsList()) {
               // doThingsWith(element);
             }
             String nextPageToken = response.getNextPageToken();
             if (!Strings.isNullOrEmpty(nextPageToken)) {
               request = request.toBuilder().setPageToken(nextPageToken).build();
             } else {
               break;
             }
           }
         }
         
      • getCompilationResult

        public final CompilationResult getCompilationResult​(CompilationResultName name)
        Fetches a single CompilationResult.

        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 (DataformClient dataformClient = DataformClient.create()) {
           CompilationResultName name =
               CompilationResultName.of(
                   "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[COMPILATION_RESULT]");
           CompilationResult response = dataformClient.getCompilationResult(name);
         }
         
        Parameters:
        name - Required. The compilation result's name.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • getCompilationResult

        public final CompilationResult getCompilationResult​(String name)
        Fetches a single CompilationResult.

        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 (DataformClient dataformClient = DataformClient.create()) {
           String name =
               CompilationResultName.of(
                       "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[COMPILATION_RESULT]")
                   .toString();
           CompilationResult response = dataformClient.getCompilationResult(name);
         }
         
        Parameters:
        name - Required. The compilation result's name.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • getCompilationResult

        public final CompilationResult getCompilationResult​(GetCompilationResultRequest request)
        Fetches a single CompilationResult.

        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 (DataformClient dataformClient = DataformClient.create()) {
           GetCompilationResultRequest request =
               GetCompilationResultRequest.newBuilder()
                   .setName(
                       CompilationResultName.of(
                               "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[COMPILATION_RESULT]")
                           .toString())
                   .build();
           CompilationResult response = dataformClient.getCompilationResult(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
      • getCompilationResultCallable

        public final com.google.api.gax.rpc.UnaryCallable<GetCompilationResultRequest,​CompilationResult> getCompilationResultCallable()
        Fetches a single CompilationResult.

        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 (DataformClient dataformClient = DataformClient.create()) {
           GetCompilationResultRequest request =
               GetCompilationResultRequest.newBuilder()
                   .setName(
                       CompilationResultName.of(
                               "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[COMPILATION_RESULT]")
                           .toString())
                   .build();
           ApiFuture<CompilationResult> future =
               dataformClient.getCompilationResultCallable().futureCall(request);
           // Do something.
           CompilationResult response = future.get();
         }
         
      • createCompilationResult

        public final CompilationResult createCompilationResult​(RepositoryName parent,
                                                               CompilationResult compilationResult)
        Creates a new CompilationResult in a given project and 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 (DataformClient dataformClient = DataformClient.create()) {
           RepositoryName parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
           CompilationResult compilationResult = CompilationResult.newBuilder().build();
           CompilationResult response =
               dataformClient.createCompilationResult(parent, compilationResult);
         }
         
        Parameters:
        parent - Required. The repository in which to create the compilation result. Must be in the format `projects/*/locations/*/repositories/*`.
        compilationResult - Required. The compilation result to create.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • createCompilationResult

        public final CompilationResult createCompilationResult​(String parent,
                                                               CompilationResult compilationResult)
        Creates a new CompilationResult in a given project and 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 (DataformClient dataformClient = DataformClient.create()) {
           String parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString();
           CompilationResult compilationResult = CompilationResult.newBuilder().build();
           CompilationResult response =
               dataformClient.createCompilationResult(parent, compilationResult);
         }
         
        Parameters:
        parent - Required. The repository in which to create the compilation result. Must be in the format `projects/*/locations/*/repositories/*`.
        compilationResult - Required. The compilation result to create.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • createCompilationResult

        public final CompilationResult createCompilationResult​(CreateCompilationResultRequest request)
        Creates a new CompilationResult in a given project and 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 (DataformClient dataformClient = DataformClient.create()) {
           CreateCompilationResultRequest request =
               CreateCompilationResultRequest.newBuilder()
                   .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
                   .setCompilationResult(CompilationResult.newBuilder().build())
                   .build();
           CompilationResult response = dataformClient.createCompilationResult(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
      • createCompilationResultCallable

        public final com.google.api.gax.rpc.UnaryCallable<CreateCompilationResultRequest,​CompilationResult> createCompilationResultCallable()
        Creates a new CompilationResult in a given project and 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 (DataformClient dataformClient = DataformClient.create()) {
           CreateCompilationResultRequest request =
               CreateCompilationResultRequest.newBuilder()
                   .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
                   .setCompilationResult(CompilationResult.newBuilder().build())
                   .build();
           ApiFuture<CompilationResult> future =
               dataformClient.createCompilationResultCallable().futureCall(request);
           // Do something.
           CompilationResult response = future.get();
         }
         
      • queryCompilationResultActions

        public final DataformClient.QueryCompilationResultActionsPagedResponse queryCompilationResultActions​(QueryCompilationResultActionsRequest request)
        Returns CompilationResultActions in a given CompilationResult.

        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 (DataformClient dataformClient = DataformClient.create()) {
           QueryCompilationResultActionsRequest request =
               QueryCompilationResultActionsRequest.newBuilder()
                   .setName(
                       CompilationResultName.of(
                               "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[COMPILATION_RESULT]")
                           .toString())
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .setFilter("filter-1274492040")
                   .build();
           for (CompilationResultAction element :
               dataformClient.queryCompilationResultActions(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
      • queryCompilationResultActionsPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<QueryCompilationResultActionsRequest,​DataformClient.QueryCompilationResultActionsPagedResponse> queryCompilationResultActionsPagedCallable()
        Returns CompilationResultActions in a given CompilationResult.

        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 (DataformClient dataformClient = DataformClient.create()) {
           QueryCompilationResultActionsRequest request =
               QueryCompilationResultActionsRequest.newBuilder()
                   .setName(
                       CompilationResultName.of(
                               "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[COMPILATION_RESULT]")
                           .toString())
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .setFilter("filter-1274492040")
                   .build();
           ApiFuture<CompilationResultAction> future =
               dataformClient.queryCompilationResultActionsPagedCallable().futureCall(request);
           // Do something.
           for (CompilationResultAction element : future.get().iterateAll()) {
             // doThingsWith(element);
           }
         }
         
      • queryCompilationResultActionsCallable

        public final com.google.api.gax.rpc.UnaryCallable<QueryCompilationResultActionsRequest,​QueryCompilationResultActionsResponse> queryCompilationResultActionsCallable()
        Returns CompilationResultActions in a given CompilationResult.

        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 (DataformClient dataformClient = DataformClient.create()) {
           QueryCompilationResultActionsRequest request =
               QueryCompilationResultActionsRequest.newBuilder()
                   .setName(
                       CompilationResultName.of(
                               "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[COMPILATION_RESULT]")
                           .toString())
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .setFilter("filter-1274492040")
                   .build();
           while (true) {
             QueryCompilationResultActionsResponse response =
                 dataformClient.queryCompilationResultActionsCallable().call(request);
             for (CompilationResultAction element : response.getCompilationResultActionsList()) {
               // doThingsWith(element);
             }
             String nextPageToken = response.getNextPageToken();
             if (!Strings.isNullOrEmpty(nextPageToken)) {
               request = request.toBuilder().setPageToken(nextPageToken).build();
             } else {
               break;
             }
           }
         }
         
      • listWorkflowInvocations

        public final DataformClient.ListWorkflowInvocationsPagedResponse listWorkflowInvocations​(RepositoryName parent)
        Lists WorkflowInvocations in a given Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           RepositoryName parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
           for (WorkflowInvocation element :
               dataformClient.listWorkflowInvocations(parent).iterateAll()) {
             // doThingsWith(element);
           }
         }
         
        Parameters:
        parent - Required. The parent resource of the WorkflowInvocation type. Must be in the format `projects/*/locations/*/repositories/*`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • listWorkflowInvocations

        public final DataformClient.ListWorkflowInvocationsPagedResponse listWorkflowInvocations​(String parent)
        Lists WorkflowInvocations in a given Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           String parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString();
           for (WorkflowInvocation element :
               dataformClient.listWorkflowInvocations(parent).iterateAll()) {
             // doThingsWith(element);
           }
         }
         
        Parameters:
        parent - Required. The parent resource of the WorkflowInvocation type. Must be in the format `projects/*/locations/*/repositories/*`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • listWorkflowInvocations

        public final DataformClient.ListWorkflowInvocationsPagedResponse listWorkflowInvocations​(ListWorkflowInvocationsRequest request)
        Lists WorkflowInvocations in a given Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           ListWorkflowInvocationsRequest request =
               ListWorkflowInvocationsRequest.newBuilder()
                   .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .build();
           for (WorkflowInvocation element :
               dataformClient.listWorkflowInvocations(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
      • listWorkflowInvocationsPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListWorkflowInvocationsRequest,​DataformClient.ListWorkflowInvocationsPagedResponse> listWorkflowInvocationsPagedCallable()
        Lists WorkflowInvocations in a given Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           ListWorkflowInvocationsRequest request =
               ListWorkflowInvocationsRequest.newBuilder()
                   .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .build();
           ApiFuture<WorkflowInvocation> future =
               dataformClient.listWorkflowInvocationsPagedCallable().futureCall(request);
           // Do something.
           for (WorkflowInvocation element : future.get().iterateAll()) {
             // doThingsWith(element);
           }
         }
         
      • listWorkflowInvocationsCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListWorkflowInvocationsRequest,​ListWorkflowInvocationsResponse> listWorkflowInvocationsCallable()
        Lists WorkflowInvocations in a given Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           ListWorkflowInvocationsRequest request =
               ListWorkflowInvocationsRequest.newBuilder()
                   .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .build();
           while (true) {
             ListWorkflowInvocationsResponse response =
                 dataformClient.listWorkflowInvocationsCallable().call(request);
             for (WorkflowInvocation element : response.getWorkflowInvocationsList()) {
               // doThingsWith(element);
             }
             String nextPageToken = response.getNextPageToken();
             if (!Strings.isNullOrEmpty(nextPageToken)) {
               request = request.toBuilder().setPageToken(nextPageToken).build();
             } else {
               break;
             }
           }
         }
         
      • getWorkflowInvocation

        public final WorkflowInvocation getWorkflowInvocation​(WorkflowInvocationName name)
        Fetches a single WorkflowInvocation.

        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 (DataformClient dataformClient = DataformClient.create()) {
           WorkflowInvocationName name =
               WorkflowInvocationName.of(
                   "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]");
           WorkflowInvocation response = dataformClient.getWorkflowInvocation(name);
         }
         
        Parameters:
        name - Required. The workflow invocation resource's name.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • getWorkflowInvocation

        public final WorkflowInvocation getWorkflowInvocation​(String name)
        Fetches a single WorkflowInvocation.

        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 (DataformClient dataformClient = DataformClient.create()) {
           String name =
               WorkflowInvocationName.of(
                       "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]")
                   .toString();
           WorkflowInvocation response = dataformClient.getWorkflowInvocation(name);
         }
         
        Parameters:
        name - Required. The workflow invocation resource's name.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • getWorkflowInvocation

        public final WorkflowInvocation getWorkflowInvocation​(GetWorkflowInvocationRequest request)
        Fetches a single WorkflowInvocation.

        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 (DataformClient dataformClient = DataformClient.create()) {
           GetWorkflowInvocationRequest request =
               GetWorkflowInvocationRequest.newBuilder()
                   .setName(
                       WorkflowInvocationName.of(
                               "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]")
                           .toString())
                   .build();
           WorkflowInvocation response = dataformClient.getWorkflowInvocation(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
      • getWorkflowInvocationCallable

        public final com.google.api.gax.rpc.UnaryCallable<GetWorkflowInvocationRequest,​WorkflowInvocation> getWorkflowInvocationCallable()
        Fetches a single WorkflowInvocation.

        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 (DataformClient dataformClient = DataformClient.create()) {
           GetWorkflowInvocationRequest request =
               GetWorkflowInvocationRequest.newBuilder()
                   .setName(
                       WorkflowInvocationName.of(
                               "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]")
                           .toString())
                   .build();
           ApiFuture<WorkflowInvocation> future =
               dataformClient.getWorkflowInvocationCallable().futureCall(request);
           // Do something.
           WorkflowInvocation response = future.get();
         }
         
      • createWorkflowInvocation

        public final WorkflowInvocation createWorkflowInvocation​(RepositoryName parent,
                                                                 WorkflowInvocation workflowInvocation)
        Creates a new WorkflowInvocation in a given Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           RepositoryName parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
           WorkflowInvocation workflowInvocation = WorkflowInvocation.newBuilder().build();
           WorkflowInvocation response =
               dataformClient.createWorkflowInvocation(parent, workflowInvocation);
         }
         
        Parameters:
        parent - Required. The repository in which to create the workflow invocation. Must be in the format `projects/*/locations/*/repositories/*`.
        workflowInvocation - Required. The workflow invocation resource to create.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • createWorkflowInvocation

        public final WorkflowInvocation createWorkflowInvocation​(String parent,
                                                                 WorkflowInvocation workflowInvocation)
        Creates a new WorkflowInvocation in a given Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           String parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString();
           WorkflowInvocation workflowInvocation = WorkflowInvocation.newBuilder().build();
           WorkflowInvocation response =
               dataformClient.createWorkflowInvocation(parent, workflowInvocation);
         }
         
        Parameters:
        parent - Required. The repository in which to create the workflow invocation. Must be in the format `projects/*/locations/*/repositories/*`.
        workflowInvocation - Required. The workflow invocation resource to create.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • createWorkflowInvocation

        public final WorkflowInvocation createWorkflowInvocation​(CreateWorkflowInvocationRequest request)
        Creates a new WorkflowInvocation in a given Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           CreateWorkflowInvocationRequest request =
               CreateWorkflowInvocationRequest.newBuilder()
                   .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
                   .setWorkflowInvocation(WorkflowInvocation.newBuilder().build())
                   .build();
           WorkflowInvocation response = dataformClient.createWorkflowInvocation(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
      • createWorkflowInvocationCallable

        public final com.google.api.gax.rpc.UnaryCallable<CreateWorkflowInvocationRequest,​WorkflowInvocation> createWorkflowInvocationCallable()
        Creates a new WorkflowInvocation in a given Repository.

        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 (DataformClient dataformClient = DataformClient.create()) {
           CreateWorkflowInvocationRequest request =
               CreateWorkflowInvocationRequest.newBuilder()
                   .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
                   .setWorkflowInvocation(WorkflowInvocation.newBuilder().build())
                   .build();
           ApiFuture<WorkflowInvocation> future =
               dataformClient.createWorkflowInvocationCallable().futureCall(request);
           // Do something.
           WorkflowInvocation response = future.get();
         }
         
      • deleteWorkflowInvocation

        public final void deleteWorkflowInvocation​(WorkflowInvocationName name)
        Deletes a single WorkflowInvocation.

        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 (DataformClient dataformClient = DataformClient.create()) {
           WorkflowInvocationName name =
               WorkflowInvocationName.of(
                   "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]");
           dataformClient.deleteWorkflowInvocation(name);
         }
         
        Parameters:
        name - Required. The workflow invocation resource's name.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • deleteWorkflowInvocation

        public final void deleteWorkflowInvocation​(String name)
        Deletes a single WorkflowInvocation.

        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 (DataformClient dataformClient = DataformClient.create()) {
           String name =
               WorkflowInvocationName.of(
                       "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]")
                   .toString();
           dataformClient.deleteWorkflowInvocation(name);
         }
         
        Parameters:
        name - Required. The workflow invocation resource's name.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • deleteWorkflowInvocation

        public final void deleteWorkflowInvocation​(DeleteWorkflowInvocationRequest request)
        Deletes a single WorkflowInvocation.

        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 (DataformClient dataformClient = DataformClient.create()) {
           DeleteWorkflowInvocationRequest request =
               DeleteWorkflowInvocationRequest.newBuilder()
                   .setName(
                       WorkflowInvocationName.of(
                               "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]")
                           .toString())
                   .build();
           dataformClient.deleteWorkflowInvocation(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
      • deleteWorkflowInvocationCallable

        public final com.google.api.gax.rpc.UnaryCallable<DeleteWorkflowInvocationRequest,​com.google.protobuf.Empty> deleteWorkflowInvocationCallable()
        Deletes a single WorkflowInvocation.

        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 (DataformClient dataformClient = DataformClient.create()) {
           DeleteWorkflowInvocationRequest request =
               DeleteWorkflowInvocationRequest.newBuilder()
                   .setName(
                       WorkflowInvocationName.of(
                               "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]")
                           .toString())
                   .build();
           ApiFuture<Empty> future =
               dataformClient.deleteWorkflowInvocationCallable().futureCall(request);
           // Do something.
           future.get();
         }
         
      • cancelWorkflowInvocation

        public final void cancelWorkflowInvocation​(CancelWorkflowInvocationRequest request)
        Requests cancellation of a running WorkflowInvocation.

        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 (DataformClient dataformClient = DataformClient.create()) {
           CancelWorkflowInvocationRequest request =
               CancelWorkflowInvocationRequest.newBuilder()
                   .setName(
                       WorkflowInvocationName.of(
                               "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]")
                           .toString())
                   .build();
           dataformClient.cancelWorkflowInvocation(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
      • cancelWorkflowInvocationCallable

        public final com.google.api.gax.rpc.UnaryCallable<CancelWorkflowInvocationRequest,​com.google.protobuf.Empty> cancelWorkflowInvocationCallable()
        Requests cancellation of a running WorkflowInvocation.

        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 (DataformClient dataformClient = DataformClient.create()) {
           CancelWorkflowInvocationRequest request =
               CancelWorkflowInvocationRequest.newBuilder()
                   .setName(
                       WorkflowInvocationName.of(
                               "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]")
                           .toString())
                   .build();
           ApiFuture<Empty> future =
               dataformClient.cancelWorkflowInvocationCallable().futureCall(request);
           // Do something.
           future.get();
         }
         
      • queryWorkflowInvocationActions

        public final DataformClient.QueryWorkflowInvocationActionsPagedResponse queryWorkflowInvocationActions​(QueryWorkflowInvocationActionsRequest request)
        Returns WorkflowInvocationActions in a given WorkflowInvocation.

        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 (DataformClient dataformClient = DataformClient.create()) {
           QueryWorkflowInvocationActionsRequest request =
               QueryWorkflowInvocationActionsRequest.newBuilder()
                   .setName(
                       WorkflowInvocationName.of(
                               "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]")
                           .toString())
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .build();
           for (WorkflowInvocationAction element :
               dataformClient.queryWorkflowInvocationActions(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
      • queryWorkflowInvocationActionsPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<QueryWorkflowInvocationActionsRequest,​DataformClient.QueryWorkflowInvocationActionsPagedResponse> queryWorkflowInvocationActionsPagedCallable()
        Returns WorkflowInvocationActions in a given WorkflowInvocation.

        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 (DataformClient dataformClient = DataformClient.create()) {
           QueryWorkflowInvocationActionsRequest request =
               QueryWorkflowInvocationActionsRequest.newBuilder()
                   .setName(
                       WorkflowInvocationName.of(
                               "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]")
                           .toString())
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .build();
           ApiFuture<WorkflowInvocationAction> future =
               dataformClient.queryWorkflowInvocationActionsPagedCallable().futureCall(request);
           // Do something.
           for (WorkflowInvocationAction element : future.get().iterateAll()) {
             // doThingsWith(element);
           }
         }
         
      • queryWorkflowInvocationActionsCallable

        public final com.google.api.gax.rpc.UnaryCallable<QueryWorkflowInvocationActionsRequest,​QueryWorkflowInvocationActionsResponse> queryWorkflowInvocationActionsCallable()
        Returns WorkflowInvocationActions in a given WorkflowInvocation.

        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 (DataformClient dataformClient = DataformClient.create()) {
           QueryWorkflowInvocationActionsRequest request =
               QueryWorkflowInvocationActionsRequest.newBuilder()
                   .setName(
                       WorkflowInvocationName.of(
                               "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]")
                           .toString())
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .build();
           while (true) {
             QueryWorkflowInvocationActionsResponse response =
                 dataformClient.queryWorkflowInvocationActionsCallable().call(request);
             for (WorkflowInvocationAction element : response.getWorkflowInvocationActionsList()) {
               // doThingsWith(element);
             }
             String nextPageToken = response.getNextPageToken();
             if (!Strings.isNullOrEmpty(nextPageToken)) {
               request = request.toBuilder().setPageToken(nextPageToken).build();
             } else {
               break;
             }
           }
         }
         
      • listLocations

        public final DataformClient.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 (DataformClient dataformClient = DataformClient.create()) {
           ListLocationsRequest request =
               ListLocationsRequest.newBuilder()
                   .setName("name3373707")
                   .setFilter("filter-1274492040")
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .build();
           for (Location element : dataformClient.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,​DataformClient.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 (DataformClient dataformClient = DataformClient.create()) {
           ListLocationsRequest request =
               ListLocationsRequest.newBuilder()
                   .setName("name3373707")
                   .setFilter("filter-1274492040")
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .build();
           ApiFuture<Location> future = dataformClient.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 (DataformClient dataformClient = DataformClient.create()) {
           ListLocationsRequest request =
               ListLocationsRequest.newBuilder()
                   .setName("name3373707")
                   .setFilter("filter-1274492040")
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .build();
           while (true) {
             ListLocationsResponse response = dataformClient.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 (DataformClient dataformClient = DataformClient.create()) {
           GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
           Location response = dataformClient.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 (DataformClient dataformClient = DataformClient.create()) {
           GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
           ApiFuture<Location> future = dataformClient.getLocationCallable().futureCall(request);
           // Do something.
           Location 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