Class DataformClient (0.18.0) 

public class DataformClient implements 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.

Inheritance

java.lang.Object > DataformClient

Implements

BackgroundResource

Static Methods

create()

public static final DataformClient create()

Constructs an instance of DataformClient with default settings.

Returns
Type Description
DataformClient
Exceptions
Type Description
IOException

create(DataformSettings settings)

public static final DataformClient create(DataformSettings settings)

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.

Parameter
Name Description
settings DataformSettings
Returns
Type Description
DataformClient
Exceptions
Type Description
IOException

create(DataformStub stub)

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

Parameter
Name Description
stub DataformStub
Returns
Type Description
DataformClient

Constructors

DataformClient(DataformSettings settings)

protected DataformClient(DataformSettings settings)

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.

Parameter
Name Description
settings DataformSettings

DataformClient(DataformStub stub)

protected DataformClient(DataformStub stub)
Parameter
Name Description
stub DataformStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

cancelWorkflowInvocation(CancelWorkflowInvocationRequest request)

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);
 }
Parameter
Name Description
request CancelWorkflowInvocationRequest

The request object containing all of the parameters for the API call.

cancelWorkflowInvocationCallable()

public final UnaryCallable<CancelWorkflowInvocationRequest,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();
 }
Returns
Type Description
UnaryCallable<CancelWorkflowInvocationRequest,Empty>

close()

public final void close()

commitWorkspaceChanges(CommitWorkspaceChangesRequest request)

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);
 }
Parameter
Name Description
request CommitWorkspaceChangesRequest

The request object containing all of the parameters for the API call.

commitWorkspaceChangesCallable()

public final UnaryCallable<CommitWorkspaceChangesRequest,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();
 }
Returns
Type Description
UnaryCallable<CommitWorkspaceChangesRequest,Empty>

createCompilationResult(CreateCompilationResultRequest request)

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);
 }
Parameter
Name Description
request CreateCompilationResultRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
CompilationResult

createCompilationResult(RepositoryName parent, CompilationResult compilationResult)

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
Name Description
parent RepositoryName

Required. The repository in which to create the compilation result. Must be in the format projects/*/locations/*/repositories/*.
compilationResult CompilationResult

Required. The compilation result to create.
Returns
Type Description
CompilationResult

createCompilationResult(String parent, CompilationResult compilationResult)

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
Name Description
parent String

Required. The repository in which to create the compilation result. Must be in the format projects/*/locations/*/repositories/*.
compilationResult CompilationResult

Required. The compilation result to create.
Returns
Type Description
CompilationResult

createCompilationResultCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<CreateCompilationResultRequest,CompilationResult>

createRepository(CreateRepositoryRequest request)

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);
 }
Parameter
Name Description
request CreateRepositoryRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Repository

createRepository(LocationName parent, Repository repository, String repositoryId)

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
Name Description
parent LocationName

Required. The location in which to create the repository. Must be in the format projects/*/locations/*.
repository Repository

Required. The repository to create.
repositoryId String

Required. The ID to use for the repository, which will become the final component of the repository's resource name.
Returns
Type Description
Repository

createRepository(String parent, Repository repository, String repositoryId)

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
Name Description
parent String

Required. The location in which to create the repository. Must be in the format projects/*/locations/*.
repository Repository

Required. The repository to create.
repositoryId String

Required. The ID to use for the repository, which will become the final component of the repository's resource name.
Returns
Type Description
Repository

createRepositoryCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<CreateRepositoryRequest,Repository>

createWorkflowInvocation(CreateWorkflowInvocationRequest request)

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);
 }
Parameter
Name Description
request CreateWorkflowInvocationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
WorkflowInvocation

createWorkflowInvocation(RepositoryName parent, WorkflowInvocation workflowInvocation)

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
Name Description
parent RepositoryName

Required. The repository in which to create the workflow invocation. Must be in the format projects/*/locations/*/repositories/*.
workflowInvocation WorkflowInvocation

Required. The workflow invocation resource to create.
Returns
Type Description
WorkflowInvocation

createWorkflowInvocation(String parent, WorkflowInvocation workflowInvocation)

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
Name Description
parent String

Required. The repository in which to create the workflow invocation. Must be in the format projects/*/locations/*/repositories/*.
workflowInvocation WorkflowInvocation

Required. The workflow invocation resource to create.
Returns
Type Description
WorkflowInvocation

createWorkflowInvocationCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<CreateWorkflowInvocationRequest,WorkflowInvocation>

createWorkspace(CreateWorkspaceRequest request)

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);
 }
Parameter
Name Description
request CreateWorkspaceRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Workspace

createWorkspace(RepositoryName parent, Workspace workspace, String workspaceId)

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
Name Description
parent RepositoryName

Required. The repository in which to create the workspace. Must be in the format projects/*/locations/*/repositories/*.
workspace Workspace

Required. The workspace to create.
workspaceId String

Required. The ID to use for the workspace, which will become the final component of the workspace's resource name.
Returns
Type Description
Workspace

createWorkspace(String parent, Workspace workspace, String workspaceId)

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
Name Description
parent String

Required. The repository in which to create the workspace. Must be in the format projects/*/locations/*/repositories/*.
workspace Workspace

Required. The workspace to create.
workspaceId String

Required. The ID to use for the workspace, which will become the final component of the workspace's resource name.
Returns
Type Description
Workspace

createWorkspaceCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<CreateWorkspaceRequest,Workspace>

deleteRepository(DeleteRepositoryRequest request)

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);
 }
Parameter
Name Description
request DeleteRepositoryRequest

The request object containing all of the parameters for the API call.

deleteRepository(RepositoryName name)

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);
 }
Parameter
Name Description
name RepositoryName

Required. The repository's name.

deleteRepository(String name)

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);
 }
Parameter
Name Description
name String

Required. The repository's name.

deleteRepositoryCallable()

public final UnaryCallable<DeleteRepositoryRequest,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();
 }
Returns
Type Description
UnaryCallable<DeleteRepositoryRequest,Empty>

deleteWorkflowInvocation(DeleteWorkflowInvocationRequest request)

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);
 }
Parameter
Name Description
request DeleteWorkflowInvocationRequest

The request object containing all of the parameters for the API call.

deleteWorkflowInvocation(WorkflowInvocationName name)

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);
 }
Parameter
Name Description
name WorkflowInvocationName

Required. The workflow invocation resource's name.

deleteWorkflowInvocation(String name)

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);
 }
Parameter
Name Description
name String

Required. The workflow invocation resource's name.

deleteWorkflowInvocationCallable()

public final UnaryCallable<DeleteWorkflowInvocationRequest,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();
 }
Returns
Type Description
UnaryCallable<DeleteWorkflowInvocationRequest,Empty>

deleteWorkspace(DeleteWorkspaceRequest request)

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);
 }
Parameter
Name Description
request DeleteWorkspaceRequest

The request object containing all of the parameters for the API call.

deleteWorkspace(WorkspaceName name)

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);
 }
Parameter
Name Description
name WorkspaceName

Required. The workspace resource's name.

deleteWorkspace(String name)

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);
 }
Parameter
Name Description
name String

Required. The workspace resource's name.

deleteWorkspaceCallable()

public final UnaryCallable<DeleteWorkspaceRequest,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();
 }
Returns
Type Description
UnaryCallable<DeleteWorkspaceRequest,Empty>

fetchFileDiff(FetchFileDiffRequest request)

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);
 }
Parameter
Name Description
request FetchFileDiffRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
FetchFileDiffResponse

fetchFileDiffCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<FetchFileDiffRequest,FetchFileDiffResponse>

fetchFileGitStatuses(FetchFileGitStatusesRequest request)

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);
 }
Parameter
Name Description
request FetchFileGitStatusesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
FetchFileGitStatusesResponse

fetchFileGitStatusesCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<FetchFileGitStatusesRequest,FetchFileGitStatusesResponse>

fetchGitAheadBehind(FetchGitAheadBehindRequest request)

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);
 }
Parameter
Name Description
request FetchGitAheadBehindRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
FetchGitAheadBehindResponse

fetchGitAheadBehindCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<FetchGitAheadBehindRequest,FetchGitAheadBehindResponse>

fetchRemoteBranches(FetchRemoteBranchesRequest request)

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);
 }
Parameter
Name Description
request FetchRemoteBranchesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
FetchRemoteBranchesResponse

fetchRemoteBranchesCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<FetchRemoteBranchesRequest,FetchRemoteBranchesResponse>

getCompilationResult(CompilationResultName name)

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);
 }
Parameter
Name Description
name CompilationResultName

Required. The compilation result's name.
Returns
Type Description
CompilationResult

getCompilationResult(GetCompilationResultRequest request)

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);
 }
Parameter
Name Description
request GetCompilationResultRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
CompilationResult

getCompilationResult(String name)

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);
 }
Parameter
Name Description
name String

Required. The compilation result's name.
Returns
Type Description
CompilationResult

getCompilationResultCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<GetCompilationResultRequest,CompilationResult>

getLocation(GetLocationRequest request)

public final Location getLocation(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);
 }
Parameter
Name Description
request com.google.cloud.location.GetLocationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

Sample code:


 // This snippet has been automatically generated 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();
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getRepository(GetRepositoryRequest request)

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);
 }
Parameter
Name Description
request GetRepositoryRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Repository

getRepository(RepositoryName name)

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);
 }
Parameter
Name Description
name RepositoryName

Required. The repository's name.
Returns
Type Description
Repository

getRepository(String name)

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);
 }
Parameter
Name Description
name String

Required. The repository's name.
Returns
Type Description
Repository

getRepositoryCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<GetRepositoryRequest,Repository>

getSettings()

public final DataformSettings getSettings()
Returns
Type Description
DataformSettings

getStub()

public DataformStub getStub()
Returns
Type Description
DataformStub

getWorkflowInvocation(GetWorkflowInvocationRequest request)

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);
 }
Parameter
Name Description
request GetWorkflowInvocationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
WorkflowInvocation

getWorkflowInvocation(WorkflowInvocationName name)

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);
 }
Parameter
Name Description
name WorkflowInvocationName

Required. The workflow invocation resource's name.
Returns
Type Description
WorkflowInvocation

getWorkflowInvocation(String name)

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);
 }
Parameter
Name Description
name String

Required. The workflow invocation resource's name.
Returns
Type Description
WorkflowInvocation

getWorkflowInvocationCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<GetWorkflowInvocationRequest,WorkflowInvocation>

getWorkspace(GetWorkspaceRequest request)

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);
 }
Parameter
Name Description
request GetWorkspaceRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Workspace

getWorkspace(WorkspaceName name)

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);
 }
Parameter
Name Description
name WorkspaceName

Required. The workspace's name.
Returns
Type Description
Workspace

getWorkspace(String name)

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);
 }
Parameter
Name Description
name String

Required. The workspace's name.
Returns
Type Description
Workspace

getWorkspaceCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<GetWorkspaceRequest,Workspace>

installNpmPackages(InstallNpmPackagesRequest request)

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);
 }
Parameter
Name Description
request InstallNpmPackagesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
InstallNpmPackagesResponse

installNpmPackagesCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<InstallNpmPackagesRequest,InstallNpmPackagesResponse>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listCompilationResults(ListCompilationResultsRequest request)

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);
   }
 }
Parameter
Name Description
request ListCompilationResultsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DataformClient.ListCompilationResultsPagedResponse

listCompilationResults(RepositoryName parent)

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);
   }
 }
Parameter
Name Description
parent RepositoryName

Required. The repository in which to list compilation results. Must be in the format projects/*/locations/*/repositories/*.
Returns
Type Description
DataformClient.ListCompilationResultsPagedResponse

listCompilationResults(String parent)

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);
   }
 }
Parameter
Name Description
parent String

Required. The repository in which to list compilation results. Must be in the format projects/*/locations/*/repositories/*.
Returns
Type Description
DataformClient.ListCompilationResultsPagedResponse

listCompilationResultsCallable()

public final 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;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListCompilationResultsRequest,ListCompilationResultsResponse>

listCompilationResultsPagedCallable()

public final 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);
   }
 }
Returns
Type Description
UnaryCallable<ListCompilationResultsRequest,ListCompilationResultsPagedResponse>

listLocations(ListLocationsRequest request)

public final DataformClient.ListLocationsPagedResponse listLocations(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);
   }
 }
Parameter
Name Description
request com.google.cloud.location.ListLocationsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DataformClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated 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;
     }
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<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);
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

listRepositories(ListRepositoriesRequest request)

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);
   }
 }
Parameter
Name Description
request ListRepositoriesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DataformClient.ListRepositoriesPagedResponse

listRepositories(LocationName parent)

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);
   }
 }
Parameter
Name Description
parent LocationName

Required. The location in which to list repositories. Must be in the format projects/*/locations/*.
Returns
Type Description
DataformClient.ListRepositoriesPagedResponse

listRepositories(String parent)

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);
   }
 }
Parameter
Name Description
parent String

Required. The location in which to list repositories. Must be in the format projects/*/locations/*.
Returns
Type Description
DataformClient.ListRepositoriesPagedResponse

listRepositoriesCallable()

public final 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;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListRepositoriesRequest,ListRepositoriesResponse>

listRepositoriesPagedCallable()

public final 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);
   }
 }
Returns
Type Description
UnaryCallable<ListRepositoriesRequest,ListRepositoriesPagedResponse>

listWorkflowInvocations(ListWorkflowInvocationsRequest request)

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);
   }
 }
Parameter
Name Description
request ListWorkflowInvocationsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DataformClient.ListWorkflowInvocationsPagedResponse

listWorkflowInvocations(RepositoryName parent)

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);
   }
 }
Parameter
Name Description
parent RepositoryName

Required. The parent resource of the WorkflowInvocation type. Must be in the format projects/*/locations/*/repositories/*.
Returns
Type Description
DataformClient.ListWorkflowInvocationsPagedResponse

listWorkflowInvocations(String parent)

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);
   }
 }
Parameter
Name Description
parent String

Required. The parent resource of the WorkflowInvocation type. Must be in the format projects/*/locations/*/repositories/*.
Returns
Type Description
DataformClient.ListWorkflowInvocationsPagedResponse

listWorkflowInvocationsCallable()

public final 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;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListWorkflowInvocationsRequest,ListWorkflowInvocationsResponse>

listWorkflowInvocationsPagedCallable()

public final 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);
   }
 }
Returns
Type Description
UnaryCallable<ListWorkflowInvocationsRequest,ListWorkflowInvocationsPagedResponse>

listWorkspaces(ListWorkspacesRequest request)

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);
   }
 }
Parameter
Name Description
request ListWorkspacesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DataformClient.ListWorkspacesPagedResponse

listWorkspaces(RepositoryName parent)

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);
   }
 }
Parameter
Name Description
parent RepositoryName

Required. The repository in which to list workspaces. Must be in the format projects/*/locations/*/repositories/*.
Returns
Type Description
DataformClient.ListWorkspacesPagedResponse

listWorkspaces(String parent)

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);
   }
 }
Parameter
Name Description
parent String

Required. The repository in which to list workspaces. Must be in the format projects/*/locations/*/repositories/*.
Returns
Type Description
DataformClient.ListWorkspacesPagedResponse

listWorkspacesCallable()

public final 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;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListWorkspacesRequest,ListWorkspacesResponse>

listWorkspacesPagedCallable()

public final 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);
   }
 }
Returns
Type Description
UnaryCallable<ListWorkspacesRequest,ListWorkspacesPagedResponse>

makeDirectory(MakeDirectoryRequest request)

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);
 }
Parameter
Name Description
request MakeDirectoryRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
MakeDirectoryResponse

makeDirectoryCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<MakeDirectoryRequest,MakeDirectoryResponse>

moveDirectory(MoveDirectoryRequest request)

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);
 }
Parameter
Name Description
request MoveDirectoryRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
MoveDirectoryResponse

moveDirectoryCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<MoveDirectoryRequest,MoveDirectoryResponse>

moveFile(MoveFileRequest request)

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);
 }
Parameter
Name Description
request MoveFileRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
MoveFileResponse

moveFileCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<MoveFileRequest,MoveFileResponse>

pullGitCommits(PullGitCommitsRequest request)

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);
 }
Parameter
Name Description
request PullGitCommitsRequest

The request object containing all of the parameters for the API call.

pullGitCommitsCallable()

public final UnaryCallable<PullGitCommitsRequest,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();
 }
Returns
Type Description
UnaryCallable<PullGitCommitsRequest,Empty>

pushGitCommits(PushGitCommitsRequest request)

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);
 }
Parameter
Name Description
request PushGitCommitsRequest

The request object containing all of the parameters for the API call.

pushGitCommitsCallable()

public final UnaryCallable<PushGitCommitsRequest,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();
 }
Returns
Type Description
UnaryCallable<PushGitCommitsRequest,Empty>

queryCompilationResultActions(QueryCompilationResultActionsRequest request)

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);
   }
 }
Parameter
Name Description
request QueryCompilationResultActionsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DataformClient.QueryCompilationResultActionsPagedResponse

queryCompilationResultActionsCallable()

public final 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;
     }
   }
 }
Returns
Type Description
UnaryCallable<QueryCompilationResultActionsRequest,QueryCompilationResultActionsResponse>

queryCompilationResultActionsPagedCallable()

public final 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);
   }
 }
Returns
Type Description
UnaryCallable<QueryCompilationResultActionsRequest,QueryCompilationResultActionsPagedResponse>

queryDirectoryContents(QueryDirectoryContentsRequest request)

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);
   }
 }
Parameter
Name Description
request QueryDirectoryContentsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DataformClient.QueryDirectoryContentsPagedResponse

queryDirectoryContentsCallable()

public final 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;
     }
   }
 }
Returns
Type Description
UnaryCallable<QueryDirectoryContentsRequest,QueryDirectoryContentsResponse>

queryDirectoryContentsPagedCallable()

public final 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);
   }
 }
Returns
Type Description
UnaryCallable<QueryDirectoryContentsRequest,QueryDirectoryContentsPagedResponse>

queryWorkflowInvocationActions(QueryWorkflowInvocationActionsRequest request)

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);
   }
 }
Parameter
Name Description
request QueryWorkflowInvocationActionsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DataformClient.QueryWorkflowInvocationActionsPagedResponse

queryWorkflowInvocationActionsCallable()

public final 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;
     }
   }
 }
Returns
Type Description
UnaryCallable<QueryWorkflowInvocationActionsRequest,QueryWorkflowInvocationActionsResponse>

queryWorkflowInvocationActionsPagedCallable()

public final 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);
   }
 }
Returns
Type Description
UnaryCallable<QueryWorkflowInvocationActionsRequest,QueryWorkflowInvocationActionsPagedResponse>

readFile(ReadFileRequest request)

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);
 }
Parameter
Name Description
request ReadFileRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ReadFileResponse

readFileCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<ReadFileRequest,ReadFileResponse>

removeDirectory(RemoveDirectoryRequest request)

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);
 }
Parameter
Name Description
request RemoveDirectoryRequest

The request object containing all of the parameters for the API call.

removeDirectoryCallable()

public final UnaryCallable<RemoveDirectoryRequest,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();
 }
Returns
Type Description
UnaryCallable<RemoveDirectoryRequest,Empty>

removeFile(RemoveFileRequest request)

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);
 }
Parameter
Name Description
request RemoveFileRequest

The request object containing all of the parameters for the API call.

removeFileCallable()

public final UnaryCallable<RemoveFileRequest,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();
 }
Returns
Type Description
UnaryCallable<RemoveFileRequest,Empty>

resetWorkspaceChanges(ResetWorkspaceChangesRequest request)

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);
 }
Parameter
Name Description
request ResetWorkspaceChangesRequest

The request object containing all of the parameters for the API call.

resetWorkspaceChangesCallable()

public final UnaryCallable<ResetWorkspaceChangesRequest,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();
 }
Returns
Type Description
UnaryCallable<ResetWorkspaceChangesRequest,Empty>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateRepository(Repository repository, FieldMask updateMask)

public final Repository updateRepository(Repository repository, 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
Name Description
repository Repository

Required. The repository to update.
updateMask FieldMask

Optional. Specifies the fields to be updated in the repository. If left unset, all fields will be updated.
Returns
Type Description
Repository

updateRepository(UpdateRepositoryRequest request)

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);
 }
Parameter
Name Description
request UpdateRepositoryRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Repository

updateRepositoryCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<UpdateRepositoryRequest,Repository>

writeFile(WriteFileRequest request)

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);
 }
Parameter
Name Description
request WriteFileRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
WriteFileResponse

writeFileCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<WriteFileRequest,WriteFileResponse>