Class DataformClient
- All Implemented Interfaces:
BackgroundResource,AutoCloseable
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()) {
TeamFolderName name = TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]");
TeamFolder response = dataformClient.getTeamFolder(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().
| Method | Description | Method Variants |
|---|---|---|
GetTeamFolder |
Fetches a single TeamFolder. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateTeamFolder |
Creates a new TeamFolder in a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateTeamFolder |
Updates a single TeamFolder. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteTeamFolder |
Deletes a single TeamFolder. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteTeamFolderTree |
Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
QueryTeamFolderContents |
Returns the contents of a given TeamFolder. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SearchTeamFolders |
Returns all TeamFolders in a given location that the caller has access to and match the provided filter. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetFolder |
Fetches a single Folder. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateFolder |
Creates a new Folder in a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateFolder |
Updates a single Folder. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteFolder |
Deletes a single Folder. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteFolderTree |
Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
QueryFolderContents |
Returns the contents of a given Folder. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
QueryUserRootContents |
Returns the contents of a caller's root folder in a given location. The root folder contains all resources that are created by the user and not contained in any other folder. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
MoveFolder |
Moves a Folder to a new Folder, TeamFolder, or the root location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListRepositories |
Lists Repositories in a given project and location. **Note:** *This method can return repositories not shown in the [Dataform UI](https://console.cloud.google.com/bigquery/dataform)*. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetRepository |
Fetches a single Repository. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateRepository |
Creates a new Repository in a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateRepository |
Updates a single Repository. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.* |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteRepository |
Deletes a single Repository. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
MoveRepository |
Moves a Repository to a new location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CommitRepositoryChanges |
Applies a Git commit to a Repository. The Repository must not have a value for `git_remote_settings.url`. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ReadRepositoryFile |
Returns the contents of a file (inside a Repository). The Repository must not have a value for `git_remote_settings.url`. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
QueryRepositoryDirectoryContents |
Returns the contents of a given Repository directory. The Repository must not have a value for `git_remote_settings.url`. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
FetchRepositoryHistory |
Fetches a Repository's history of commits. The Repository must not have a value for `git_remote_settings.url`. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ComputeRepositoryAccessTokenStatus |
Computes a Repository's Git access token status. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
FetchRemoteBranches |
Fetches a Repository's remote branches. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListWorkspaces |
Lists Workspaces in a given Repository. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetWorkspace |
Fetches a single Workspace. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateWorkspace |
Creates a new Workspace in a given Repository. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteWorkspace |
Deletes a single Workspace. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
InstallNpmPackages |
Installs dependency NPM packages (inside a Workspace). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
PullGitCommits |
Pulls Git commits from the Repository's remote into a Workspace. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
PushGitCommits |
Pushes Git commits from a Workspace to the Repository's remote. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
FetchFileGitStatuses |
Fetches Git statuses for the files in a Workspace. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
FetchGitAheadBehind |
Fetches Git ahead/behind against a remote branch. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CommitWorkspaceChanges |
Applies a Git commit for uncommitted files in a Workspace. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ResetWorkspaceChanges |
Performs a Git reset for uncommitted files in a Workspace. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
FetchFileDiff |
Fetches Git diff for an uncommitted file in a Workspace. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
QueryDirectoryContents |
Returns the contents of a given Workspace directory. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SearchFiles |
Finds the contents of a given Workspace directory by filter. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
MakeDirectory |
Creates a directory inside a Workspace. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
RemoveDirectory |
Deletes a directory (inside a Workspace) and all of its contents. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
MoveDirectory |
Moves a directory (inside a Workspace), and all of its contents, to a new location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ReadFile |
Returns the contents of a file (inside a Workspace). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
RemoveFile |
Deletes a file (inside a Workspace). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
MoveFile |
Moves a file (inside a Workspace) to a new location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
WriteFile |
Writes to a file (inside a Workspace). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListReleaseConfigs |
Lists ReleaseConfigs in a given Repository. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetReleaseConfig |
Fetches a single ReleaseConfig. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateReleaseConfig |
Creates a new ReleaseConfig in a given Repository. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateReleaseConfig |
Updates a single ReleaseConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.* |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteReleaseConfig |
Deletes a single ReleaseConfig. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListCompilationResults |
Lists CompilationResults in a given Repository. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetCompilationResult |
Fetches a single CompilationResult. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateCompilationResult |
Creates a new CompilationResult in a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
QueryCompilationResultActions |
Returns CompilationResultActions in a given CompilationResult. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListWorkflowConfigs |
Lists WorkflowConfigs in a given Repository. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetWorkflowConfig |
Fetches a single WorkflowConfig. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateWorkflowConfig |
Creates a new WorkflowConfig in a given Repository. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateWorkflowConfig |
Updates a single WorkflowConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.* |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteWorkflowConfig |
Deletes a single WorkflowConfig. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListWorkflowInvocations |
Lists WorkflowInvocations in a given Repository. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetWorkflowInvocation |
Fetches a single WorkflowInvocation. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateWorkflowInvocation |
Creates a new WorkflowInvocation in a given Repository. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteWorkflowInvocation |
Deletes a single WorkflowInvocation. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CancelWorkflowInvocation |
Requests cancellation of a running WorkflowInvocation. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
QueryWorkflowInvocationActions |
Returns WorkflowInvocationActions in a given WorkflowInvocation. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetConfig |
Get default config for a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateConfig |
Update default config for a given project and location. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.* |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetIamPolicy |
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SetIamPolicy |
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
TestIamPermissions |
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListLocations |
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided inthe [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists thepublic locations available to all projects. * **Project-specificlocations**: If `name` follows the format`projects/{project}`, the method lists locations visible to thatspecific project. This includes public, private, or otherproject-specific locations enabled for the project. For gRPC and client library implementations, the resource name ispassed as the `name` field. For direct service calls, the resourcename isincorporated into the request path based on the specific serviceimplementation and version. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetLocation |
Gets information about a location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return 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.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic class -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDataformClient(DataformSettings settings) Constructs an instance of DataformClient, using the given settings.protectedDataformClient(DataformStub stub) -
Method Summary
Modifier and TypeMethodDescriptionbooleanawaitTermination(long duration, TimeUnit unit) Requests cancellation of a running WorkflowInvocation.Requests cancellation of a running WorkflowInvocation.final voidclose()Applies a Git commit to a Repository.Applies a Git commit to a Repository.Applies a Git commit for uncommitted files in a Workspace.Applies a Git commit for uncommitted files in a Workspace.Computes a Repository's Git access token status.final UnaryCallable<ComputeRepositoryAccessTokenStatusRequest,ComputeRepositoryAccessTokenStatusResponse> Computes a Repository's Git access token status.static final DataformClientcreate()Constructs an instance of DataformClient with default settings.static final DataformClientcreate(DataformSettings settings) Constructs an instance of DataformClient, using the given settings.static final DataformClientcreate(DataformStub stub) Constructs an instance of DataformClient, using the given stub for making calls.final CompilationResultCreates a new CompilationResult in a given project and location.final CompilationResultcreateCompilationResult(RepositoryName parent, CompilationResult compilationResult) Creates a new CompilationResult in a given project and location.final CompilationResultcreateCompilationResult(String parent, CompilationResult compilationResult) Creates a new CompilationResult in a given project and location.Creates a new CompilationResult in a given project and location.final FoldercreateFolder(CreateFolderRequest request) Creates a new Folder in a given project and location.final FoldercreateFolder(LocationName parent, Folder folder) Creates a new Folder in a given project and location.final FoldercreateFolder(String parent, Folder folder) Creates a new Folder in a given project and location.Creates a new Folder in a given project and location.final ReleaseConfigCreates a new ReleaseConfig in a given Repository.final ReleaseConfigcreateReleaseConfig(RepositoryName parent, ReleaseConfig releaseConfig, String releaseConfigId) Creates a new ReleaseConfig in a given Repository.final ReleaseConfigcreateReleaseConfig(String parent, ReleaseConfig releaseConfig, String releaseConfigId) Creates a new ReleaseConfig in a given Repository.Creates a new ReleaseConfig in a given Repository.final RepositorycreateRepository(CreateRepositoryRequest request) Creates a new Repository in a given project and location.final RepositorycreateRepository(LocationName parent, Repository repository, String repositoryId) Creates a new Repository in a given project and location.final RepositorycreateRepository(String parent, Repository repository, String repositoryId) Creates a new Repository in a given project and location.Creates a new Repository in a given project and location.final TeamFoldercreateTeamFolder(CreateTeamFolderRequest request) Creates a new TeamFolder in a given project and location.final TeamFoldercreateTeamFolder(LocationName parent, TeamFolder teamFolder) Creates a new TeamFolder in a given project and location.final TeamFoldercreateTeamFolder(String parent, TeamFolder teamFolder) Creates a new TeamFolder in a given project and location.Creates a new TeamFolder in a given project and location.final WorkflowConfigCreates a new WorkflowConfig in a given Repository.final WorkflowConfigcreateWorkflowConfig(RepositoryName parent, WorkflowConfig workflowConfig, String workflowConfigId) Creates a new WorkflowConfig in a given Repository.final WorkflowConfigcreateWorkflowConfig(String parent, WorkflowConfig workflowConfig, String workflowConfigId) Creates a new WorkflowConfig in a given Repository.Creates a new WorkflowConfig in a given Repository.final WorkflowInvocationCreates a new WorkflowInvocation in a given Repository.final WorkflowInvocationcreateWorkflowInvocation(RepositoryName parent, WorkflowInvocation workflowInvocation) Creates a new WorkflowInvocation in a given Repository.final WorkflowInvocationcreateWorkflowInvocation(String parent, WorkflowInvocation workflowInvocation) Creates a new WorkflowInvocation in a given Repository.Creates a new WorkflowInvocation in a given Repository.final WorkspacecreateWorkspace(CreateWorkspaceRequest request) Creates a new Workspace in a given Repository.final WorkspacecreateWorkspace(RepositoryName parent, Workspace workspace, String workspaceId) Creates a new Workspace in a given Repository.final WorkspacecreateWorkspace(String parent, Workspace workspace, String workspaceId) Creates a new Workspace in a given Repository.Creates a new Workspace in a given Repository.final voiddeleteFolder(DeleteFolderRequest request) Deletes a single Folder.final voiddeleteFolder(FolderName name) Deletes a single Folder.final voiddeleteFolder(String name) Deletes a single Folder.final UnaryCallable<DeleteFolderRequest,com.google.protobuf.Empty> Deletes a single Folder.final OperationFuture<com.google.protobuf.Empty,DeleteFolderTreeMetadata> Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).final OperationFuture<com.google.protobuf.Empty,DeleteFolderTreeMetadata> deleteFolderTreeAsync(FolderName name, boolean force) Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).final OperationFuture<com.google.protobuf.Empty,DeleteFolderTreeMetadata> deleteFolderTreeAsync(String name, boolean force) Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).final OperationCallable<DeleteFolderTreeRequest,com.google.protobuf.Empty, DeleteFolderTreeMetadata> Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).final voidDeletes a single ReleaseConfig.final voidDeletes a single ReleaseConfig.final voiddeleteReleaseConfig(String name) Deletes a single ReleaseConfig.final UnaryCallable<DeleteReleaseConfigRequest,com.google.protobuf.Empty> Deletes a single ReleaseConfig.final voiddeleteRepository(DeleteRepositoryRequest request) Deletes a single Repository.final voidDeletes a single Repository.final voiddeleteRepository(String name) Deletes a single Repository.final UnaryCallable<DeleteRepositoryRequest,com.google.protobuf.Empty> Deletes a single Repository.final voiddeleteTeamFolder(DeleteTeamFolderRequest request) Deletes a single TeamFolder.final voidDeletes a single TeamFolder.final voiddeleteTeamFolder(String name) Deletes a single TeamFolder.final UnaryCallable<DeleteTeamFolderRequest,com.google.protobuf.Empty> Deletes a single TeamFolder.final OperationFuture<com.google.protobuf.Empty,DeleteFolderTreeMetadata> Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).final OperationFuture<com.google.protobuf.Empty,DeleteFolderTreeMetadata> deleteTeamFolderTreeAsync(TeamFolderName name, boolean force) Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).final OperationFuture<com.google.protobuf.Empty,DeleteFolderTreeMetadata> deleteTeamFolderTreeAsync(String name, boolean force) Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).final OperationCallable<DeleteTeamFolderTreeRequest,com.google.protobuf.Empty, DeleteFolderTreeMetadata> Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).final voidDeletes a single WorkflowConfig.final voidDeletes a single WorkflowConfig.final voiddeleteWorkflowConfig(String name) Deletes a single WorkflowConfig.final UnaryCallable<DeleteWorkflowConfigRequest,com.google.protobuf.Empty> Deletes a single WorkflowConfig.final voidDeletes a single WorkflowInvocation.final voidDeletes a single WorkflowInvocation.final voidDeletes a single WorkflowInvocation.final UnaryCallable<DeleteWorkflowInvocationRequest,com.google.protobuf.Empty> Deletes a single WorkflowInvocation.final voiddeleteWorkspace(DeleteWorkspaceRequest request) Deletes a single Workspace.final voiddeleteWorkspace(WorkspaceName name) Deletes a single Workspace.final voiddeleteWorkspace(String name) Deletes a single Workspace.final UnaryCallable<DeleteWorkspaceRequest,com.google.protobuf.Empty> Deletes a single Workspace.final FetchFileDiffResponsefetchFileDiff(FetchFileDiffRequest request) Fetches Git diff for an uncommitted file in a Workspace.Fetches Git diff for an uncommitted file in a Workspace.Fetches Git statuses for the files in a Workspace.Fetches Git statuses for the files in a Workspace.Fetches Git ahead/behind against a remote branch.Fetches Git ahead/behind against a remote branch.Fetches a Repository's remote branches.Fetches a Repository's remote branches.Fetches a Repository's history of commits.Fetches a Repository's history of commits.final UnaryCallable<FetchRepositoryHistoryRequest,DataformClient.FetchRepositoryHistoryPagedResponse> Fetches a Repository's history of commits.final CompilationResultFetches a single CompilationResult.final CompilationResultFetches a single CompilationResult.final CompilationResultgetCompilationResult(String name) Fetches a single CompilationResult.Fetches a single CompilationResult.final ConfiggetConfig(ConfigName name) Get default config for a given project and location.final ConfiggetConfig(GetConfigRequest request) Get default config for a given project and location.final ConfigGet default config for a given project and location.final UnaryCallable<GetConfigRequest,Config> Get default config for a given project and location.final FoldergetFolder(FolderName name) Fetches a single Folder.final FoldergetFolder(GetFolderRequest request) Fetches a single Folder.final FolderFetches a single Folder.final UnaryCallable<GetFolderRequest,Folder> Fetches a single Folder.final OperationsClientReturns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.final PolicygetIamPolicy(ResourceName resource) Gets the access control policy for a resource.final PolicygetIamPolicy(GetIamPolicyRequest request) Gets the access control policy for a resource.final PolicygetIamPolicy(String resource) Gets the access control policy for a resource.Gets the access control policy for a resource.final LocationgetLocation(GetLocationRequest request) Gets information about a location.Gets information about a location.final OperationsClientReturns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.final ReleaseConfiggetReleaseConfig(GetReleaseConfigRequest request) Fetches a single ReleaseConfig.final ReleaseConfigFetches a single ReleaseConfig.final ReleaseConfiggetReleaseConfig(String name) Fetches a single ReleaseConfig.Fetches a single ReleaseConfig.final RepositorygetRepository(GetRepositoryRequest request) Fetches a single Repository.final RepositorygetRepository(RepositoryName name) Fetches a single Repository.final RepositorygetRepository(String name) Fetches a single Repository.Fetches a single Repository.final DataformSettingsgetStub()final TeamFoldergetTeamFolder(GetTeamFolderRequest request) Fetches a single TeamFolder.final TeamFoldergetTeamFolder(TeamFolderName name) Fetches a single TeamFolder.final TeamFoldergetTeamFolder(String name) Fetches a single TeamFolder.Fetches a single TeamFolder.final WorkflowConfigFetches a single WorkflowConfig.final WorkflowConfigFetches a single WorkflowConfig.final WorkflowConfiggetWorkflowConfig(String name) Fetches a single WorkflowConfig.Fetches a single WorkflowConfig.final WorkflowInvocationFetches a single WorkflowInvocation.final WorkflowInvocationFetches a single WorkflowInvocation.final WorkflowInvocationgetWorkflowInvocation(String name) Fetches a single WorkflowInvocation.Fetches a single WorkflowInvocation.final WorkspacegetWorkspace(GetWorkspaceRequest request) Fetches a single Workspace.final WorkspacegetWorkspace(WorkspaceName name) Fetches a single Workspace.final WorkspacegetWorkspace(String name) Fetches a single Workspace.Fetches a single Workspace.Installs dependency NPM packages (inside a Workspace).Installs dependency NPM packages (inside a Workspace).booleanbooleanLists CompilationResults in a given Repository.listCompilationResults(RepositoryName parent) Lists CompilationResults in a given Repository.listCompilationResults(String parent) Lists CompilationResults in a given Repository.Lists CompilationResults in a given Repository.final UnaryCallable<ListCompilationResultsRequest,DataformClient.ListCompilationResultsPagedResponse> Lists CompilationResults in a given Repository.listLocations(ListLocationsRequest request) Lists information about the supported locations for this service.Lists information about the supported locations for this service.Lists information about the supported locations for this service.Lists ReleaseConfigs in a given Repository.listReleaseConfigs(RepositoryName parent) Lists ReleaseConfigs in a given Repository.listReleaseConfigs(String parent) Lists ReleaseConfigs in a given Repository.Lists ReleaseConfigs in a given Repository.Lists ReleaseConfigs in a given Repository.listRepositories(ListRepositoriesRequest request) Lists Repositories in a given project and location.listRepositories(LocationName parent) Lists Repositories in a given project and location.listRepositories(String parent) Lists Repositories in a given project and location.Lists Repositories in a given project and location.Lists Repositories in a given project and location.Lists WorkflowConfigs in a given Repository.listWorkflowConfigs(RepositoryName parent) Lists WorkflowConfigs in a given Repository.listWorkflowConfigs(String parent) Lists WorkflowConfigs in a given Repository.Lists WorkflowConfigs in a given Repository.Lists WorkflowConfigs in a given Repository.Lists WorkflowInvocations in a given Repository.Lists WorkflowInvocations in a given Repository.listWorkflowInvocations(String parent) Lists WorkflowInvocations in a given Repository.Lists WorkflowInvocations in a given Repository.final UnaryCallable<ListWorkflowInvocationsRequest,DataformClient.ListWorkflowInvocationsPagedResponse> Lists WorkflowInvocations in a given Repository.listWorkspaces(ListWorkspacesRequest request) Lists Workspaces in a given Repository.listWorkspaces(RepositoryName parent) Lists Workspaces in a given Repository.listWorkspaces(String parent) Lists Workspaces in a given Repository.Lists Workspaces in a given Repository.Lists Workspaces in a given Repository.final MakeDirectoryResponsemakeDirectory(MakeDirectoryRequest request) Creates a directory inside a Workspace.Creates a directory inside a Workspace.final MoveDirectoryResponsemoveDirectory(MoveDirectoryRequest request) Moves a directory (inside a Workspace), and all of its contents, to a new location.Moves a directory (inside a Workspace), and all of its contents, to a new location.final MoveFileResponsemoveFile(MoveFileRequest request) Moves a file (inside a Workspace) to a new location.Moves a file (inside a Workspace) to a new location.final OperationFuture<com.google.protobuf.Empty,MoveFolderMetadata> moveFolderAsync(FolderName name, String destinationContainingFolder) Moves a Folder to a new Folder, TeamFolder, or the root location.final OperationFuture<com.google.protobuf.Empty,MoveFolderMetadata> moveFolderAsync(MoveFolderRequest request) Moves a Folder to a new Folder, TeamFolder, or the root location.final OperationFuture<com.google.protobuf.Empty,MoveFolderMetadata> moveFolderAsync(String name, String destinationContainingFolder) Moves a Folder to a new Folder, TeamFolder, or the root location.Moves a Folder to a new Folder, TeamFolder, or the root location.final OperationCallable<MoveFolderRequest,com.google.protobuf.Empty, MoveFolderMetadata> Moves a Folder to a new Folder, TeamFolder, or the root location.final OperationFuture<com.google.protobuf.Empty,MoveRepositoryMetadata> moveRepositoryAsync(MoveRepositoryRequest request) Moves a Repository to a new location.final OperationFuture<com.google.protobuf.Empty,MoveRepositoryMetadata> moveRepositoryAsync(RepositoryName name, String destinationContainingFolder) Moves a Repository to a new location.final OperationFuture<com.google.protobuf.Empty,MoveRepositoryMetadata> moveRepositoryAsync(String name, String destinationContainingFolder) Moves a Repository to a new location.Moves a Repository to a new location.final OperationCallable<MoveRepositoryRequest,com.google.protobuf.Empty, MoveRepositoryMetadata> Moves a Repository to a new location.final PullGitCommitsResponsepullGitCommits(PullGitCommitsRequest request) Pulls Git commits from the Repository's remote into a Workspace.Pulls Git commits from the Repository's remote into a Workspace.final PushGitCommitsResponsepushGitCommits(PushGitCommitsRequest request) Pushes Git commits from a Workspace to the Repository's remote.Pushes Git commits from a Workspace to the Repository's remote.Returns CompilationResultActions in a given CompilationResult.Returns CompilationResultActions in a given CompilationResult.final UnaryCallable<QueryCompilationResultActionsRequest,DataformClient.QueryCompilationResultActionsPagedResponse> Returns CompilationResultActions in a given CompilationResult.Returns the contents of a given Workspace directory.Returns the contents of a given Workspace directory.final UnaryCallable<QueryDirectoryContentsRequest,DataformClient.QueryDirectoryContentsPagedResponse> Returns the contents of a given Workspace directory.queryFolderContents(FolderName folder) Returns the contents of a given Folder.Returns the contents of a given Folder.queryFolderContents(String folder) Returns the contents of a given Folder.Returns the contents of a given Folder.Returns the contents of a given Folder.Returns the contents of a given Repository directory.final UnaryCallable<QueryRepositoryDirectoryContentsRequest,QueryRepositoryDirectoryContentsResponse> Returns the contents of a given Repository directory.final UnaryCallable<QueryRepositoryDirectoryContentsRequest,DataformClient.QueryRepositoryDirectoryContentsPagedResponse> Returns the contents of a given Repository directory.Returns the contents of a given TeamFolder.queryTeamFolderContents(TeamFolderName teamFolder) Returns the contents of a given TeamFolder.queryTeamFolderContents(String teamFolder) Returns the contents of a given TeamFolder.Returns the contents of a given TeamFolder.final UnaryCallable<QueryTeamFolderContentsRequest,DataformClient.QueryTeamFolderContentsPagedResponse> Returns the contents of a given TeamFolder.queryUserRootContents(LocationName location) Returns the contents of a caller's root folder in a given location.Returns the contents of a caller's root folder in a given location.queryUserRootContents(String location) Returns the contents of a caller's root folder in a given location.Returns the contents of a caller's root folder in a given location.Returns the contents of a caller's root folder in a given location.Returns WorkflowInvocationActions in a given WorkflowInvocation.Returns WorkflowInvocationActions in a given WorkflowInvocation.final UnaryCallable<QueryWorkflowInvocationActionsRequest,DataformClient.QueryWorkflowInvocationActionsPagedResponse> Returns WorkflowInvocationActions in a given WorkflowInvocation.final ReadFileResponsereadFile(ReadFileRequest request) Returns the contents of a file (inside a Workspace).Returns the contents of a file (inside a Workspace).Returns the contents of a file (inside a Repository).Returns the contents of a file (inside a Repository).final RemoveDirectoryResponseremoveDirectory(RemoveDirectoryRequest request) Deletes a directory (inside a Workspace) and all of its contents.Deletes a directory (inside a Workspace) and all of its contents.final RemoveFileResponseremoveFile(RemoveFileRequest request) Deletes a file (inside a Workspace).Deletes a file (inside a Workspace).Performs a Git reset for uncommitted files in a Workspace.Performs a Git reset for uncommitted files in a Workspace.searchFiles(SearchFilesRequest request) Finds the contents of a given Workspace directory by filter.Finds the contents of a given Workspace directory by filter.Finds the contents of a given Workspace directory by filter.Returns all TeamFolders in a given location that the caller has access to and match the provided filter.Returns all TeamFolders in a given location that the caller has access to and match the provided filter.Returns all TeamFolders in a given location that the caller has access to and match the provided filter.final PolicysetIamPolicy(SetIamPolicyRequest request) Sets the access control policy on the specified resource.Sets the access control policy on the specified resource.voidshutdown()voidReturns permissions that a caller has on the specified resource.Returns permissions that a caller has on the specified resource.final ConfigupdateConfig(Config config, com.google.protobuf.FieldMask updateMask) Update default config for a given project and location.final ConfigupdateConfig(UpdateConfigRequest request) Update default config for a given project and location.Update default config for a given project and location.final FolderupdateFolder(Folder folder, com.google.protobuf.FieldMask updateMask) Updates a single Folder.final FolderupdateFolder(UpdateFolderRequest request) Updates a single Folder.Updates a single Folder.final ReleaseConfigupdateReleaseConfig(ReleaseConfig releaseConfig, com.google.protobuf.FieldMask updateMask) Updates a single ReleaseConfig.final ReleaseConfigUpdates a single ReleaseConfig.Updates a single ReleaseConfig.final RepositoryupdateRepository(Repository repository, com.google.protobuf.FieldMask updateMask) Updates a single Repository.final RepositoryupdateRepository(UpdateRepositoryRequest request) Updates a single Repository.Updates a single Repository.final TeamFolderupdateTeamFolder(TeamFolder teamFolder, com.google.protobuf.FieldMask updateMask) Updates a single TeamFolder.final TeamFolderupdateTeamFolder(UpdateTeamFolderRequest request) Updates a single TeamFolder.Updates a single TeamFolder.final WorkflowConfigUpdates a single WorkflowConfig.final WorkflowConfigupdateWorkflowConfig(WorkflowConfig workflowConfig, com.google.protobuf.FieldMask updateMask) Updates a single WorkflowConfig.Updates a single WorkflowConfig.final WriteFileResponsewriteFile(WriteFileRequest request) Writes to a file (inside a Workspace).Writes to a file (inside a Workspace).
-
Constructor Details
-
DataformClient
Constructs an instance of DataformClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.- Throws:
IOException
-
DataformClient
-
-
Method Details
-
create
Constructs an instance of DataformClient with default settings.- Throws:
IOException
-
create
Constructs an instance of DataformClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.- Throws:
IOException
-
create
Constructs an instance of DataformClient, using the given stub for making calls. This is for advanced usage - prefer using create(DataformSettings). -
getSettings
-
getStub
-
getOperationsClient
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call. -
getHttpJsonOperationsClient
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call. -
getTeamFolder
Fetches a single TeamFolder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { TeamFolderName name = TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]"); TeamFolder response = dataformClient.getTeamFolder(name); }- Parameters:
name- Required. The TeamFolder's name.- Throws:
ApiException- if the remote call fails
-
getTeamFolder
Fetches a single TeamFolder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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 = TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString(); TeamFolder response = dataformClient.getTeamFolder(name); }- Parameters:
name- Required. The TeamFolder's name.- Throws:
ApiException- if the remote call fails
-
getTeamFolder
Fetches a single TeamFolder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { GetTeamFolderRequest request = GetTeamFolderRequest.newBuilder() .setName(TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString()) .build(); TeamFolder response = dataformClient.getTeamFolder(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
getTeamFolderCallable
Fetches a single TeamFolder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { GetTeamFolderRequest request = GetTeamFolderRequest.newBuilder() .setName(TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString()) .build(); ApiFuture<TeamFolder> future = dataformClient.getTeamFolderCallable().futureCall(request); // Do something. TeamFolder response = future.get(); } -
createTeamFolder
Creates a new TeamFolder 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]"); TeamFolder teamFolder = TeamFolder.newBuilder().build(); TeamFolder response = dataformClient.createTeamFolder(parent, teamFolder); }- Parameters:
parent- Required. The location in which to create the TeamFolder. Must be in the format `projects/*/locations/*`.teamFolder- Required. The TeamFolder to create.- Throws:
ApiException- if the remote call fails
-
createTeamFolder
Creates a new TeamFolder 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(); TeamFolder teamFolder = TeamFolder.newBuilder().build(); TeamFolder response = dataformClient.createTeamFolder(parent, teamFolder); }- Parameters:
parent- Required. The location in which to create the TeamFolder. Must be in the format `projects/*/locations/*`.teamFolder- Required. The TeamFolder to create.- Throws:
ApiException- if the remote call fails
-
createTeamFolder
Creates a new TeamFolder 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()) { CreateTeamFolderRequest request = CreateTeamFolderRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setTeamFolder(TeamFolder.newBuilder().build()) .build(); TeamFolder response = dataformClient.createTeamFolder(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
createTeamFolderCallable
Creates a new TeamFolder 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()) { CreateTeamFolderRequest request = CreateTeamFolderRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setTeamFolder(TeamFolder.newBuilder().build()) .build(); ApiFuture<TeamFolder> future = dataformClient.createTeamFolderCallable().futureCall(request); // Do something. TeamFolder response = future.get(); } -
updateTeamFolder
public final TeamFolder updateTeamFolder(TeamFolder teamFolder, com.google.protobuf.FieldMask updateMask) Updates a single TeamFolder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { TeamFolder teamFolder = TeamFolder.newBuilder().build(); FieldMask updateMask = FieldMask.newBuilder().build(); TeamFolder response = dataformClient.updateTeamFolder(teamFolder, updateMask); }- Parameters:
teamFolder- Required. The updated TeamFolder.updateMask- Optional. Specifies the fields to be updated in the Folder. If left unset, all fields will be updated.- Throws:
ApiException- if the remote call fails
-
updateTeamFolder
Updates a single TeamFolder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { UpdateTeamFolderRequest request = UpdateTeamFolderRequest.newBuilder() .setUpdateMask(FieldMask.newBuilder().build()) .setTeamFolder(TeamFolder.newBuilder().build()) .build(); TeamFolder response = dataformClient.updateTeamFolder(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
updateTeamFolderCallable
Updates a single TeamFolder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { UpdateTeamFolderRequest request = UpdateTeamFolderRequest.newBuilder() .setUpdateMask(FieldMask.newBuilder().build()) .setTeamFolder(TeamFolder.newBuilder().build()) .build(); ApiFuture<TeamFolder> future = dataformClient.updateTeamFolderCallable().futureCall(request); // Do something. TeamFolder response = future.get(); } -
deleteTeamFolder
Deletes a single TeamFolder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { TeamFolderName name = TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]"); dataformClient.deleteTeamFolder(name); }- Parameters:
name- Required. The TeamFolder's name.- Throws:
ApiException- if the remote call fails
-
deleteTeamFolder
Deletes a single TeamFolder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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 = TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString(); dataformClient.deleteTeamFolder(name); }- Parameters:
name- Required. The TeamFolder's name.- Throws:
ApiException- if the remote call fails
-
deleteTeamFolder
Deletes a single TeamFolder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { DeleteTeamFolderRequest request = DeleteTeamFolderRequest.newBuilder() .setName(TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString()) .build(); dataformClient.deleteTeamFolder(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
deleteTeamFolderCallable
public final UnaryCallable<DeleteTeamFolderRequest,com.google.protobuf.Empty> deleteTeamFolderCallable()Deletes a single TeamFolder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { DeleteTeamFolderRequest request = DeleteTeamFolderRequest.newBuilder() .setName(TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString()) .build(); ApiFuture<Empty> future = dataformClient.deleteTeamFolderCallable().futureCall(request); // Do something. future.get(); } -
deleteTeamFolderTreeAsync
public final OperationFuture<com.google.protobuf.Empty,DeleteFolderTreeMetadata> deleteTeamFolderTreeAsync(TeamFolderName name, boolean force) Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { TeamFolderName name = TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]"); boolean force = true; dataformClient.deleteTeamFolderTreeAsync(name, force).get(); }- Parameters:
name- Required. The TeamFolder's name. Format: projects/{project}/locations/{location}/teamFolders/{team_folder}force- Optional. If `false` (default): The operation will fail if any Repository within the folder hierarchy has associated Release Configs or Workflow Configs.If `true`: The operation will attempt to delete everything, including any Release Configs and Workflow Configs linked to Repositories within the folder hierarchy. This permanently removes schedules and resources.
- Throws:
ApiException- if the remote call fails
-
deleteTeamFolderTreeAsync
public final OperationFuture<com.google.protobuf.Empty,DeleteFolderTreeMetadata> deleteTeamFolderTreeAsync(String name, boolean force) Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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 = TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString(); boolean force = true; dataformClient.deleteTeamFolderTreeAsync(name, force).get(); }- Parameters:
name- Required. The TeamFolder's name. Format: projects/{project}/locations/{location}/teamFolders/{team_folder}force- Optional. If `false` (default): The operation will fail if any Repository within the folder hierarchy has associated Release Configs or Workflow Configs.If `true`: The operation will attempt to delete everything, including any Release Configs and Workflow Configs linked to Repositories within the folder hierarchy. This permanently removes schedules and resources.
- Throws:
ApiException- if the remote call fails
-
deleteTeamFolderTreeAsync
public final OperationFuture<com.google.protobuf.Empty,DeleteFolderTreeMetadata> deleteTeamFolderTreeAsync(DeleteTeamFolderTreeRequest request) Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { DeleteTeamFolderTreeRequest request = DeleteTeamFolderTreeRequest.newBuilder() .setName(TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString()) .setForce(true) .build(); dataformClient.deleteTeamFolderTreeAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
deleteTeamFolderTreeOperationCallable
public final OperationCallable<DeleteTeamFolderTreeRequest,com.google.protobuf.Empty, deleteTeamFolderTreeOperationCallable()DeleteFolderTreeMetadata> Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { DeleteTeamFolderTreeRequest request = DeleteTeamFolderTreeRequest.newBuilder() .setName(TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString()) .setForce(true) .build(); OperationFuture<Empty, DeleteFolderTreeMetadata> future = dataformClient.deleteTeamFolderTreeOperationCallable().futureCall(request); // Do something. future.get(); } -
deleteTeamFolderTreeCallable
Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { DeleteTeamFolderTreeRequest request = DeleteTeamFolderTreeRequest.newBuilder() .setName(TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString()) .setForce(true) .build(); ApiFuture<Operation> future = dataformClient.deleteTeamFolderTreeCallable().futureCall(request); // Do something. future.get(); } -
queryTeamFolderContents
public final DataformClient.QueryTeamFolderContentsPagedResponse queryTeamFolderContents(TeamFolderName teamFolder) Returns the contents of a given TeamFolder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { TeamFolderName teamFolder = TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]"); for (QueryTeamFolderContentsResponse.TeamFolderContentsEntry element : dataformClient.queryTeamFolderContents(teamFolder).iterateAll()) { // doThingsWith(element); } }- Parameters:
teamFolder- Required. Name of the team_folder whose contents to list. Format: `projects/*/locations/*/teamFolders/*`.- Throws:
ApiException- if the remote call fails
-
queryTeamFolderContents
public final DataformClient.QueryTeamFolderContentsPagedResponse queryTeamFolderContents(String teamFolder) Returns the contents of a given TeamFolder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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 teamFolder = TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString(); for (QueryTeamFolderContentsResponse.TeamFolderContentsEntry element : dataformClient.queryTeamFolderContents(teamFolder).iterateAll()) { // doThingsWith(element); } }- Parameters:
teamFolder- Required. Name of the team_folder whose contents to list. Format: `projects/*/locations/*/teamFolders/*`.- Throws:
ApiException- if the remote call fails
-
queryTeamFolderContents
public final DataformClient.QueryTeamFolderContentsPagedResponse queryTeamFolderContents(QueryTeamFolderContentsRequest request) Returns the contents of a given TeamFolder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { QueryTeamFolderContentsRequest request = QueryTeamFolderContentsRequest.newBuilder() .setTeamFolder( TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .build(); for (QueryTeamFolderContentsResponse.TeamFolderContentsEntry element : dataformClient.queryTeamFolderContents(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
queryTeamFolderContentsPagedCallable
public final UnaryCallable<QueryTeamFolderContentsRequest,DataformClient.QueryTeamFolderContentsPagedResponse> queryTeamFolderContentsPagedCallable()Returns the contents of a given TeamFolder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { QueryTeamFolderContentsRequest request = QueryTeamFolderContentsRequest.newBuilder() .setTeamFolder( TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .build(); ApiFuture<QueryTeamFolderContentsResponse.TeamFolderContentsEntry> future = dataformClient.queryTeamFolderContentsPagedCallable().futureCall(request); // Do something. for (QueryTeamFolderContentsResponse.TeamFolderContentsEntry element : future.get().iterateAll()) { // doThingsWith(element); } } -
queryTeamFolderContentsCallable
public final UnaryCallable<QueryTeamFolderContentsRequest,QueryTeamFolderContentsResponse> queryTeamFolderContentsCallable()Returns the contents of a given TeamFolder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { QueryTeamFolderContentsRequest request = QueryTeamFolderContentsRequest.newBuilder() .setTeamFolder( TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .build(); while (true) { QueryTeamFolderContentsResponse response = dataformClient.queryTeamFolderContentsCallable().call(request); for (QueryTeamFolderContentsResponse.TeamFolderContentsEntry element : response.getEntriesList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
searchTeamFolders
public final DataformClient.SearchTeamFoldersPagedResponse searchTeamFolders(SearchTeamFoldersRequest request) Returns all TeamFolders in a given location that the caller has access to and match the provided filter.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { SearchTeamFoldersRequest request = SearchTeamFoldersRequest.newBuilder() .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .build(); for (SearchTeamFoldersResponse.TeamFolderSearchResult element : dataformClient.searchTeamFolders(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
searchTeamFoldersPagedCallable
public final UnaryCallable<SearchTeamFoldersRequest,DataformClient.SearchTeamFoldersPagedResponse> searchTeamFoldersPagedCallable()Returns all TeamFolders in a given location that the caller has access to and match the provided filter.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { SearchTeamFoldersRequest request = SearchTeamFoldersRequest.newBuilder() .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .build(); ApiFuture<SearchTeamFoldersResponse.TeamFolderSearchResult> future = dataformClient.searchTeamFoldersPagedCallable().futureCall(request); // Do something. for (SearchTeamFoldersResponse.TeamFolderSearchResult element : future.get().iterateAll()) { // doThingsWith(element); } } -
searchTeamFoldersCallable
public final UnaryCallable<SearchTeamFoldersRequest,SearchTeamFoldersResponse> searchTeamFoldersCallable()Returns all TeamFolders in a given location that the caller has access to and match the provided filter.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { SearchTeamFoldersRequest request = SearchTeamFoldersRequest.newBuilder() .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .build(); while (true) { SearchTeamFoldersResponse response = dataformClient.searchTeamFoldersCallable().call(request); for (SearchTeamFoldersResponse.TeamFolderSearchResult element : response.getResultsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
getFolder
Fetches a single Folder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { FolderName name = FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]"); Folder response = dataformClient.getFolder(name); }- Parameters:
name- Required. The Folder's name.- Throws:
ApiException- if the remote call fails
-
getFolder
Fetches a single Folder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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 = FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString(); Folder response = dataformClient.getFolder(name); }- Parameters:
name- Required. The Folder's name.- Throws:
ApiException- if the remote call fails
-
getFolder
Fetches a single Folder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { GetFolderRequest request = GetFolderRequest.newBuilder() .setName(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString()) .build(); Folder response = dataformClient.getFolder(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
getFolderCallable
Fetches a single Folder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { GetFolderRequest request = GetFolderRequest.newBuilder() .setName(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString()) .build(); ApiFuture<Folder> future = dataformClient.getFolderCallable().futureCall(request); // Do something. Folder response = future.get(); } -
createFolder
Creates a new Folder 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]"); Folder folder = Folder.newBuilder().build(); Folder response = dataformClient.createFolder(parent, folder); }- Parameters:
parent- Required. The location in which to create the Folder. Must be in the format `projects/*/locations/*`.folder- Required. The Folder to create.- Throws:
ApiException- if the remote call fails
-
createFolder
Creates a new Folder 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(); Folder folder = Folder.newBuilder().build(); Folder response = dataformClient.createFolder(parent, folder); }- Parameters:
parent- Required. The location in which to create the Folder. Must be in the format `projects/*/locations/*`.folder- Required. The Folder to create.- Throws:
ApiException- if the remote call fails
-
createFolder
Creates a new Folder 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()) { CreateFolderRequest request = CreateFolderRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setFolder(Folder.newBuilder().build()) .build(); Folder response = dataformClient.createFolder(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
createFolderCallable
Creates a new Folder 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()) { CreateFolderRequest request = CreateFolderRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setFolder(Folder.newBuilder().build()) .build(); ApiFuture<Folder> future = dataformClient.createFolderCallable().futureCall(request); // Do something. Folder response = future.get(); } -
updateFolder
Updates a single Folder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { Folder folder = Folder.newBuilder().build(); FieldMask updateMask = FieldMask.newBuilder().build(); Folder response = dataformClient.updateFolder(folder, updateMask); }- Parameters:
folder- Required. The updated Folder.updateMask- Optional. Specifies the fields to be updated in the Folder. If left unset, all fields that can be updated, will be updated. A few fields cannot be updated and will be ignored if specified in the update_mask (e.g. parent_name, team_folder_name).- Throws:
ApiException- if the remote call fails
-
updateFolder
Updates a single Folder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { UpdateFolderRequest request = UpdateFolderRequest.newBuilder() .setUpdateMask(FieldMask.newBuilder().build()) .setFolder(Folder.newBuilder().build()) .build(); Folder response = dataformClient.updateFolder(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
updateFolderCallable
Updates a single Folder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { UpdateFolderRequest request = UpdateFolderRequest.newBuilder() .setUpdateMask(FieldMask.newBuilder().build()) .setFolder(Folder.newBuilder().build()) .build(); ApiFuture<Folder> future = dataformClient.updateFolderCallable().futureCall(request); // Do something. Folder response = future.get(); } -
deleteFolder
Deletes a single Folder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { FolderName name = FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]"); dataformClient.deleteFolder(name); }- Parameters:
name- Required. The Folder's name.- Throws:
ApiException- if the remote call fails
-
deleteFolder
Deletes a single Folder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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 = FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString(); dataformClient.deleteFolder(name); }- Parameters:
name- Required. The Folder's name.- Throws:
ApiException- if the remote call fails
-
deleteFolder
Deletes a single Folder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { DeleteFolderRequest request = DeleteFolderRequest.newBuilder() .setName(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString()) .build(); dataformClient.deleteFolder(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
deleteFolderCallable
Deletes a single Folder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { DeleteFolderRequest request = DeleteFolderRequest.newBuilder() .setName(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString()) .build(); ApiFuture<Empty> future = dataformClient.deleteFolderCallable().futureCall(request); // Do something. future.get(); } -
deleteFolderTreeAsync
public final OperationFuture<com.google.protobuf.Empty,DeleteFolderTreeMetadata> deleteFolderTreeAsync(FolderName name, boolean force) Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { FolderName name = FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]"); boolean force = true; dataformClient.deleteFolderTreeAsync(name, force).get(); }- Parameters:
name- Required. The Folder's name. Format: projects/{project}/locations/{location}/folders/{folder}force- Optional. If `false` (default): The operation will fail if any Repository within the folder hierarchy has associated Release Configs or Workflow Configs.If `true`: The operation will attempt to delete everything, including any Release Configs and Workflow Configs linked to Repositories within the folder hierarchy. This permanently removes schedules and resources.
- Throws:
ApiException- if the remote call fails
-
deleteFolderTreeAsync
public final OperationFuture<com.google.protobuf.Empty,DeleteFolderTreeMetadata> deleteFolderTreeAsync(String name, boolean force) Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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 = FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString(); boolean force = true; dataformClient.deleteFolderTreeAsync(name, force).get(); }- Parameters:
name- Required. The Folder's name. Format: projects/{project}/locations/{location}/folders/{folder}force- Optional. If `false` (default): The operation will fail if any Repository within the folder hierarchy has associated Release Configs or Workflow Configs.If `true`: The operation will attempt to delete everything, including any Release Configs and Workflow Configs linked to Repositories within the folder hierarchy. This permanently removes schedules and resources.
- Throws:
ApiException- if the remote call fails
-
deleteFolderTreeAsync
public final OperationFuture<com.google.protobuf.Empty,DeleteFolderTreeMetadata> deleteFolderTreeAsync(DeleteFolderTreeRequest request) Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { DeleteFolderTreeRequest request = DeleteFolderTreeRequest.newBuilder() .setName(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString()) .setForce(true) .build(); dataformClient.deleteFolderTreeAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
deleteFolderTreeOperationCallable
public final OperationCallable<DeleteFolderTreeRequest,com.google.protobuf.Empty, deleteFolderTreeOperationCallable()DeleteFolderTreeMetadata> Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { DeleteFolderTreeRequest request = DeleteFolderTreeRequest.newBuilder() .setName(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString()) .setForce(true) .build(); OperationFuture<Empty, DeleteFolderTreeMetadata> future = dataformClient.deleteFolderTreeOperationCallable().futureCall(request); // Do something. future.get(); } -
deleteFolderTreeCallable
Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { DeleteFolderTreeRequest request = DeleteFolderTreeRequest.newBuilder() .setName(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString()) .setForce(true) .build(); ApiFuture<Operation> future = dataformClient.deleteFolderTreeCallable().futureCall(request); // Do something. future.get(); } -
queryFolderContents
Returns the contents of a given Folder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { FolderName folder = FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]"); for (QueryFolderContentsResponse.FolderContentsEntry element : dataformClient.queryFolderContents(folder).iterateAll()) { // doThingsWith(element); } }- Parameters:
folder- Required. Name of the folder whose contents to list. Format: projects/*/locations/*/folders/*- Throws:
ApiException- if the remote call fails
-
queryFolderContents
Returns the contents of a given Folder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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 folder = FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString(); for (QueryFolderContentsResponse.FolderContentsEntry element : dataformClient.queryFolderContents(folder).iterateAll()) { // doThingsWith(element); } }- Parameters:
folder- Required. Name of the folder whose contents to list. Format: projects/*/locations/*/folders/*- Throws:
ApiException- if the remote call fails
-
queryFolderContents
public final DataformClient.QueryFolderContentsPagedResponse queryFolderContents(QueryFolderContentsRequest request) Returns the contents of a given Folder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { QueryFolderContentsRequest request = QueryFolderContentsRequest.newBuilder() .setFolder(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .build(); for (QueryFolderContentsResponse.FolderContentsEntry element : dataformClient.queryFolderContents(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
queryFolderContentsPagedCallable
public final UnaryCallable<QueryFolderContentsRequest,DataformClient.QueryFolderContentsPagedResponse> queryFolderContentsPagedCallable()Returns the contents of a given Folder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { QueryFolderContentsRequest request = QueryFolderContentsRequest.newBuilder() .setFolder(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .build(); ApiFuture<QueryFolderContentsResponse.FolderContentsEntry> future = dataformClient.queryFolderContentsPagedCallable().futureCall(request); // Do something. for (QueryFolderContentsResponse.FolderContentsEntry element : future.get().iterateAll()) { // doThingsWith(element); } } -
queryFolderContentsCallable
public final UnaryCallable<QueryFolderContentsRequest,QueryFolderContentsResponse> queryFolderContentsCallable()Returns the contents of a given Folder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { QueryFolderContentsRequest request = QueryFolderContentsRequest.newBuilder() .setFolder(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .build(); while (true) { QueryFolderContentsResponse response = dataformClient.queryFolderContentsCallable().call(request); for (QueryFolderContentsResponse.FolderContentsEntry element : response.getEntriesList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
queryUserRootContents
public final DataformClient.QueryUserRootContentsPagedResponse queryUserRootContents(LocationName location) Returns the contents of a caller's root folder in a given location. The root folder contains all resources that are created by the user and not contained in any other folder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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 location = LocationName.of("[PROJECT]", "[LOCATION]"); for (QueryUserRootContentsResponse.RootContentsEntry element : dataformClient.queryUserRootContents(location).iterateAll()) { // doThingsWith(element); } }- Parameters:
location- Required. Location of the user root folder whose contents to list. Format: projects/*/locations/*- Throws:
ApiException- if the remote call fails
-
queryUserRootContents
public final DataformClient.QueryUserRootContentsPagedResponse queryUserRootContents(String location) Returns the contents of a caller's root folder in a given location. The root folder contains all resources that are created by the user and not contained in any other folder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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 location = LocationName.of("[PROJECT]", "[LOCATION]").toString(); for (QueryUserRootContentsResponse.RootContentsEntry element : dataformClient.queryUserRootContents(location).iterateAll()) { // doThingsWith(element); } }- Parameters:
location- Required. Location of the user root folder whose contents to list. Format: projects/*/locations/*- Throws:
ApiException- if the remote call fails
-
queryUserRootContents
public final DataformClient.QueryUserRootContentsPagedResponse queryUserRootContents(QueryUserRootContentsRequest request) Returns the contents of a caller's root folder in a given location. The root folder contains all resources that are created by the user and not contained in any other folder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { QueryUserRootContentsRequest request = QueryUserRootContentsRequest.newBuilder() .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .build(); for (QueryUserRootContentsResponse.RootContentsEntry element : dataformClient.queryUserRootContents(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
queryUserRootContentsPagedCallable
public final UnaryCallable<QueryUserRootContentsRequest,DataformClient.QueryUserRootContentsPagedResponse> queryUserRootContentsPagedCallable()Returns the contents of a caller's root folder in a given location. The root folder contains all resources that are created by the user and not contained in any other folder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { QueryUserRootContentsRequest request = QueryUserRootContentsRequest.newBuilder() .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .build(); ApiFuture<QueryUserRootContentsResponse.RootContentsEntry> future = dataformClient.queryUserRootContentsPagedCallable().futureCall(request); // Do something. for (QueryUserRootContentsResponse.RootContentsEntry element : future.get().iterateAll()) { // doThingsWith(element); } } -
queryUserRootContentsCallable
public final UnaryCallable<QueryUserRootContentsRequest,QueryUserRootContentsResponse> queryUserRootContentsCallable()Returns the contents of a caller's root folder in a given location. The root folder contains all resources that are created by the user and not contained in any other folder.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { QueryUserRootContentsRequest request = QueryUserRootContentsRequest.newBuilder() .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .build(); while (true) { QueryUserRootContentsResponse response = dataformClient.queryUserRootContentsCallable().call(request); for (QueryUserRootContentsResponse.RootContentsEntry element : response.getEntriesList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
moveFolderAsync
public final OperationFuture<com.google.protobuf.Empty,MoveFolderMetadata> moveFolderAsync(FolderName name, String destinationContainingFolder) Moves a Folder to a new Folder, TeamFolder, or the root 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()) { FolderName name = FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]"); String destinationContainingFolder = "destinationContainingFolder870737098"; dataformClient.moveFolderAsync(name, destinationContainingFolder).get(); }- Parameters:
name- Required. The full resource name of the Folder to move.destinationContainingFolder- Optional. The name of the Folder, TeamFolder, or root location to move the Folder to. Can be in the format of: "" to move into the root User folder, `projects/*/locations/*/folders/*`, `projects/*/locations/*/teamFolders/*`- Throws:
ApiException- if the remote call fails
-
moveFolderAsync
public final OperationFuture<com.google.protobuf.Empty,MoveFolderMetadata> moveFolderAsync(String name, String destinationContainingFolder) Moves a Folder to a new Folder, TeamFolder, or the root 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 name = FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString(); String destinationContainingFolder = "destinationContainingFolder870737098"; dataformClient.moveFolderAsync(name, destinationContainingFolder).get(); }- Parameters:
name- Required. The full resource name of the Folder to move.destinationContainingFolder- Optional. The name of the Folder, TeamFolder, or root location to move the Folder to. Can be in the format of: "" to move into the root User folder, `projects/*/locations/*/folders/*`, `projects/*/locations/*/teamFolders/*`- Throws:
ApiException- if the remote call fails
-
moveFolderAsync
public final OperationFuture<com.google.protobuf.Empty,MoveFolderMetadata> moveFolderAsync(MoveFolderRequest request) Moves a Folder to a new Folder, TeamFolder, or the root 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()) { MoveFolderRequest request = MoveFolderRequest.newBuilder() .setName(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString()) .setDestinationContainingFolder("destinationContainingFolder870737098") .build(); dataformClient.moveFolderAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
moveFolderOperationCallable
public final OperationCallable<MoveFolderRequest,com.google.protobuf.Empty, moveFolderOperationCallable()MoveFolderMetadata> Moves a Folder to a new Folder, TeamFolder, or the root 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()) { MoveFolderRequest request = MoveFolderRequest.newBuilder() .setName(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString()) .setDestinationContainingFolder("destinationContainingFolder870737098") .build(); OperationFuture<Empty, MoveFolderMetadata> future = dataformClient.moveFolderOperationCallable().futureCall(request); // Do something. future.get(); } -
moveFolderCallable
Moves a Folder to a new Folder, TeamFolder, or the root 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()) { MoveFolderRequest request = MoveFolderRequest.newBuilder() .setName(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString()) .setDestinationContainingFolder("destinationContainingFolder870737098") .build(); ApiFuture<Operation> future = dataformClient.moveFolderCallable().futureCall(request); // Do something. future.get(); } -
listRepositories
Lists Repositories in a given project and location.**Note:** *This method can return repositories not shown in the [Dataform UI](https://console.cloud.google.com/bigquery/dataform)*.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); for (Repository element : dataformClient.listRepositories(parent).iterateAll()) { // doThingsWith(element); } }- Parameters:
parent- Required. The location in which to list repositories. Must be in the format `projects/*/locations/*`.- Throws:
ApiException- if the remote call fails
-
listRepositories
Lists Repositories in a given project and location.**Note:** *This method can return repositories not shown in the [Dataform UI](https://console.cloud.google.com/bigquery/dataform)*.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); for (Repository element : dataformClient.listRepositories(parent).iterateAll()) { // doThingsWith(element); } }- Parameters:
parent- Required. The location in which to list repositories. Must be in the format `projects/*/locations/*`.- Throws:
ApiException- if the remote call fails
-
listRepositories
public final DataformClient.ListRepositoriesPagedResponse listRepositories(ListRepositoriesRequest request) Lists Repositories in a given project and location.**Note:** *This method can return repositories not shown in the [Dataform UI](https://console.cloud.google.com/bigquery/dataform)*.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { ListRepositoriesRequest request = ListRepositoriesRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .build(); for (Repository element : dataformClient.listRepositories(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
listRepositoriesPagedCallable
public final UnaryCallable<ListRepositoriesRequest,DataformClient.ListRepositoriesPagedResponse> listRepositoriesPagedCallable()Lists Repositories in a given project and location.**Note:** *This method can return repositories not shown in the [Dataform UI](https://console.cloud.google.com/bigquery/dataform)*.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { ListRepositoriesRequest request = ListRepositoriesRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .build(); ApiFuture<Repository> future = dataformClient.listRepositoriesPagedCallable().futureCall(request); // Do something. for (Repository element : future.get().iterateAll()) { // doThingsWith(element); } } -
listRepositoriesCallable
public final UnaryCallable<ListRepositoriesRequest,ListRepositoriesResponse> listRepositoriesCallable()Lists Repositories in a given project and location.**Note:** *This method can return repositories not shown in the [Dataform UI](https://console.cloud.google.com/bigquery/dataform)*.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { ListRepositoriesRequest request = ListRepositoriesRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .build(); while (true) { ListRepositoriesResponse response = dataformClient.listRepositoriesCallable().call(request); for (Repository element : response.getRepositoriesList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
getRepository
Fetches a single Repository.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { RepositoryName name = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]"); Repository response = dataformClient.getRepository(name); }- Parameters:
name- Required. The repository's name.- Throws:
ApiException- if the remote call fails
-
getRepository
Fetches a single Repository.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { String name = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString(); Repository response = dataformClient.getRepository(name); }- Parameters:
name- Required. The repository's name.- Throws:
ApiException- if the remote call fails
-
getRepository
Fetches a single Repository.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { GetRepositoryRequest request = GetRepositoryRequest.newBuilder() .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .build(); Repository response = dataformClient.getRepository(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
getRepositoryCallable
Fetches a single Repository.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { GetRepositoryRequest request = GetRepositoryRequest.newBuilder() .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .build(); ApiFuture<Repository> future = dataformClient.getRepositoryCallable().futureCall(request); // Do something. Repository response = future.get(); } -
createRepository
public final Repository createRepository(LocationName parent, Repository repository, String repositoryId) Creates a new Repository in a given project and location.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); Repository repository = Repository.newBuilder().build(); String repositoryId = "repositoryId2113747461"; Repository response = dataformClient.createRepository(parent, repository, repositoryId); }- Parameters:
parent- Required. The location in which to create the repository. Must be in the format `projects/*/locations/*`.repository- Required. The repository to create.repositoryId- Required. The ID to use for the repository, which will become the final component of the repository's resource name.- Throws:
ApiException- if the remote call fails
-
createRepository
Creates a new Repository in a given project and location.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); Repository repository = Repository.newBuilder().build(); String repositoryId = "repositoryId2113747461"; Repository response = dataformClient.createRepository(parent, repository, repositoryId); }- Parameters:
parent- Required. The location in which to create the repository. Must be in the format `projects/*/locations/*`.repository- Required. The repository to create.repositoryId- Required. The ID to use for the repository, which will become the final component of the repository's resource name.- Throws:
ApiException- if the remote call fails
-
createRepository
Creates a new Repository in a given project and location.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { CreateRepositoryRequest request = CreateRepositoryRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setRepository(Repository.newBuilder().build()) .setRepositoryId("repositoryId2113747461") .build(); Repository response = dataformClient.createRepository(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
createRepositoryCallable
Creates a new Repository in a given project and location.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { CreateRepositoryRequest request = CreateRepositoryRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setRepository(Repository.newBuilder().build()) .setRepositoryId("repositoryId2113747461") .build(); ApiFuture<Repository> future = dataformClient.createRepositoryCallable().futureCall(request); // Do something. Repository response = future.get(); } -
updateRepository
public final Repository updateRepository(Repository repository, com.google.protobuf.FieldMask updateMask) Updates a single Repository.**Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { Repository repository = Repository.newBuilder().build(); FieldMask updateMask = FieldMask.newBuilder().build(); Repository response = dataformClient.updateRepository(repository, updateMask); }- Parameters:
repository- Required. The repository to update.updateMask- Optional. Specifies the fields to be updated in the repository. If left unset, all fields will be updated.- Throws:
ApiException- if the remote call fails
-
updateRepository
Updates a single Repository.**Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { UpdateRepositoryRequest request = UpdateRepositoryRequest.newBuilder() .setUpdateMask(FieldMask.newBuilder().build()) .setRepository(Repository.newBuilder().build()) .build(); Repository response = dataformClient.updateRepository(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
updateRepositoryCallable
Updates a single Repository.**Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { UpdateRepositoryRequest request = UpdateRepositoryRequest.newBuilder() .setUpdateMask(FieldMask.newBuilder().build()) .setRepository(Repository.newBuilder().build()) .build(); ApiFuture<Repository> future = dataformClient.updateRepositoryCallable().futureCall(request); // Do something. Repository response = future.get(); } -
deleteRepository
Deletes a single Repository.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { RepositoryName name = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]"); dataformClient.deleteRepository(name); }- Parameters:
name- Required. The repository's name.- Throws:
ApiException- if the remote call fails
-
deleteRepository
Deletes a single Repository.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { String name = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString(); dataformClient.deleteRepository(name); }- Parameters:
name- Required. The repository's name.- Throws:
ApiException- if the remote call fails
-
deleteRepository
Deletes a single Repository.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { DeleteRepositoryRequest request = DeleteRepositoryRequest.newBuilder() .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setForce(true) .build(); dataformClient.deleteRepository(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
deleteRepositoryCallable
public final UnaryCallable<DeleteRepositoryRequest,com.google.protobuf.Empty> deleteRepositoryCallable()Deletes a single Repository.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { DeleteRepositoryRequest request = DeleteRepositoryRequest.newBuilder() .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setForce(true) .build(); ApiFuture<Empty> future = dataformClient.deleteRepositoryCallable().futureCall(request); // Do something. future.get(); } -
moveRepositoryAsync
public final OperationFuture<com.google.protobuf.Empty,MoveRepositoryMetadata> moveRepositoryAsync(RepositoryName name, String destinationContainingFolder) Moves a Repository 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()) { RepositoryName name = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]"); String destinationContainingFolder = "destinationContainingFolder870737098"; dataformClient.moveRepositoryAsync(name, destinationContainingFolder).get(); }- Parameters:
name- Required. The full resource name of the repository to move.destinationContainingFolder- Optional. The name of the Folder, TeamFolder, or root location to move the repository to. Can be in the format of: "" to move into the root User folder, `projects/*/locations/*/folders/*`, `projects/*/locations/*/teamFolders/*`- Throws:
ApiException- if the remote call fails
-
moveRepositoryAsync
public final OperationFuture<com.google.protobuf.Empty,MoveRepositoryMetadata> moveRepositoryAsync(String name, String destinationContainingFolder) Moves a Repository 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()) { String name = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString(); String destinationContainingFolder = "destinationContainingFolder870737098"; dataformClient.moveRepositoryAsync(name, destinationContainingFolder).get(); }- Parameters:
name- Required. The full resource name of the repository to move.destinationContainingFolder- Optional. The name of the Folder, TeamFolder, or root location to move the repository to. Can be in the format of: "" to move into the root User folder, `projects/*/locations/*/folders/*`, `projects/*/locations/*/teamFolders/*`- Throws:
ApiException- if the remote call fails
-
moveRepositoryAsync
public final OperationFuture<com.google.protobuf.Empty,MoveRepositoryMetadata> moveRepositoryAsync(MoveRepositoryRequest request) Moves a Repository 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()) { MoveRepositoryRequest request = MoveRepositoryRequest.newBuilder() .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setDestinationContainingFolder("destinationContainingFolder870737098") .build(); dataformClient.moveRepositoryAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
moveRepositoryOperationCallable
public final OperationCallable<MoveRepositoryRequest,com.google.protobuf.Empty, moveRepositoryOperationCallable()MoveRepositoryMetadata> Moves a Repository 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()) { MoveRepositoryRequest request = MoveRepositoryRequest.newBuilder() .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setDestinationContainingFolder("destinationContainingFolder870737098") .build(); OperationFuture<Empty, MoveRepositoryMetadata> future = dataformClient.moveRepositoryOperationCallable().futureCall(request); // Do something. future.get(); } -
moveRepositoryCallable
Moves a Repository 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()) { MoveRepositoryRequest request = MoveRepositoryRequest.newBuilder() .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setDestinationContainingFolder("destinationContainingFolder870737098") .build(); ApiFuture<Operation> future = dataformClient.moveRepositoryCallable().futureCall(request); // Do something. future.get(); } -
commitRepositoryChanges
public final CommitRepositoryChangesResponse commitRepositoryChanges(CommitRepositoryChangesRequest request) Applies a Git commit to a Repository. The Repository must not have a value for `git_remote_settings.url`.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { CommitRepositoryChangesRequest request = CommitRepositoryChangesRequest.newBuilder() .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setCommitMetadata(CommitMetadata.newBuilder().build()) .setRequiredHeadCommitSha("requiredHeadCommitSha-393901930") .putAllFileOperations( new HashMap<String, CommitRepositoryChangesRequest.FileOperation>()) .build(); CommitRepositoryChangesResponse response = dataformClient.commitRepositoryChanges(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
commitRepositoryChangesCallable
public final UnaryCallable<CommitRepositoryChangesRequest,CommitRepositoryChangesResponse> commitRepositoryChangesCallable()Applies a Git commit to a Repository. The Repository must not have a value for `git_remote_settings.url`.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { CommitRepositoryChangesRequest request = CommitRepositoryChangesRequest.newBuilder() .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setCommitMetadata(CommitMetadata.newBuilder().build()) .setRequiredHeadCommitSha("requiredHeadCommitSha-393901930") .putAllFileOperations( new HashMap<String, CommitRepositoryChangesRequest.FileOperation>()) .build(); ApiFuture<CommitRepositoryChangesResponse> future = dataformClient.commitRepositoryChangesCallable().futureCall(request); // Do something. CommitRepositoryChangesResponse response = future.get(); } -
readRepositoryFile
Returns the contents of a file (inside a Repository). The Repository must not have a value for `git_remote_settings.url`.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { ReadRepositoryFileRequest request = ReadRepositoryFileRequest.newBuilder() .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setCommitSha("commitSha-1491174411") .setPath("path3433509") .build(); ReadRepositoryFileResponse response = dataformClient.readRepositoryFile(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
readRepositoryFileCallable
public final UnaryCallable<ReadRepositoryFileRequest,ReadRepositoryFileResponse> readRepositoryFileCallable()Returns the contents of a file (inside a Repository). The Repository must not have a value for `git_remote_settings.url`.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { ReadRepositoryFileRequest request = ReadRepositoryFileRequest.newBuilder() .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setCommitSha("commitSha-1491174411") .setPath("path3433509") .build(); ApiFuture<ReadRepositoryFileResponse> future = dataformClient.readRepositoryFileCallable().futureCall(request); // Do something. ReadRepositoryFileResponse response = future.get(); } -
queryRepositoryDirectoryContents
public final DataformClient.QueryRepositoryDirectoryContentsPagedResponse queryRepositoryDirectoryContents(QueryRepositoryDirectoryContentsRequest request) Returns the contents of a given Repository directory. The Repository must not have a value for `git_remote_settings.url`.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { QueryRepositoryDirectoryContentsRequest request = QueryRepositoryDirectoryContentsRequest.newBuilder() .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setCommitSha("commitSha-1491174411") .setPath("path3433509") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (DirectoryEntry element : dataformClient.queryRepositoryDirectoryContents(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
queryRepositoryDirectoryContentsPagedCallable
public final UnaryCallable<QueryRepositoryDirectoryContentsRequest,DataformClient.QueryRepositoryDirectoryContentsPagedResponse> queryRepositoryDirectoryContentsPagedCallable()Returns the contents of a given Repository directory. The Repository must not have a value for `git_remote_settings.url`.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { QueryRepositoryDirectoryContentsRequest request = QueryRepositoryDirectoryContentsRequest.newBuilder() .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setCommitSha("commitSha-1491174411") .setPath("path3433509") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<DirectoryEntry> future = dataformClient.queryRepositoryDirectoryContentsPagedCallable().futureCall(request); // Do something. for (DirectoryEntry element : future.get().iterateAll()) { // doThingsWith(element); } } -
queryRepositoryDirectoryContentsCallable
public final UnaryCallable<QueryRepositoryDirectoryContentsRequest,QueryRepositoryDirectoryContentsResponse> queryRepositoryDirectoryContentsCallable()Returns the contents of a given Repository directory. The Repository must not have a value for `git_remote_settings.url`.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { QueryRepositoryDirectoryContentsRequest request = QueryRepositoryDirectoryContentsRequest.newBuilder() .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setCommitSha("commitSha-1491174411") .setPath("path3433509") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { QueryRepositoryDirectoryContentsResponse response = dataformClient.queryRepositoryDirectoryContentsCallable().call(request); for (DirectoryEntry element : response.getDirectoryEntriesList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
fetchRepositoryHistory
public final DataformClient.FetchRepositoryHistoryPagedResponse fetchRepositoryHistory(FetchRepositoryHistoryRequest request) Fetches a Repository's history of commits. The Repository must not have a value for `git_remote_settings.url`.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { FetchRepositoryHistoryRequest request = FetchRepositoryHistoryRequest.newBuilder() .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (CommitLogEntry element : dataformClient.fetchRepositoryHistory(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
fetchRepositoryHistoryPagedCallable
public final UnaryCallable<FetchRepositoryHistoryRequest,DataformClient.FetchRepositoryHistoryPagedResponse> fetchRepositoryHistoryPagedCallable()Fetches a Repository's history of commits. The Repository must not have a value for `git_remote_settings.url`.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { FetchRepositoryHistoryRequest request = FetchRepositoryHistoryRequest.newBuilder() .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<CommitLogEntry> future = dataformClient.fetchRepositoryHistoryPagedCallable().futureCall(request); // Do something. for (CommitLogEntry element : future.get().iterateAll()) { // doThingsWith(element); } } -
fetchRepositoryHistoryCallable
public final UnaryCallable<FetchRepositoryHistoryRequest,FetchRepositoryHistoryResponse> fetchRepositoryHistoryCallable()Fetches a Repository's history of commits. The Repository must not have a value for `git_remote_settings.url`.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { FetchRepositoryHistoryRequest request = FetchRepositoryHistoryRequest.newBuilder() .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { FetchRepositoryHistoryResponse response = dataformClient.fetchRepositoryHistoryCallable().call(request); for (CommitLogEntry element : response.getCommitsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
computeRepositoryAccessTokenStatus
public final ComputeRepositoryAccessTokenStatusResponse computeRepositoryAccessTokenStatus(ComputeRepositoryAccessTokenStatusRequest request) Computes a Repository's Git access token status.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { ComputeRepositoryAccessTokenStatusRequest request = ComputeRepositoryAccessTokenStatusRequest.newBuilder() .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .build(); ComputeRepositoryAccessTokenStatusResponse response = dataformClient.computeRepositoryAccessTokenStatus(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
computeRepositoryAccessTokenStatusCallable
public final UnaryCallable<ComputeRepositoryAccessTokenStatusRequest,ComputeRepositoryAccessTokenStatusResponse> computeRepositoryAccessTokenStatusCallable()Computes a Repository's Git access token status.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { ComputeRepositoryAccessTokenStatusRequest request = ComputeRepositoryAccessTokenStatusRequest.newBuilder() .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .build(); ApiFuture<ComputeRepositoryAccessTokenStatusResponse> future = dataformClient.computeRepositoryAccessTokenStatusCallable().futureCall(request); // Do something. ComputeRepositoryAccessTokenStatusResponse response = future.get(); } -
fetchRemoteBranches
Fetches a Repository's remote branches.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { FetchRemoteBranchesRequest request = FetchRemoteBranchesRequest.newBuilder() .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .build(); FetchRemoteBranchesResponse response = dataformClient.fetchRemoteBranches(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
listWorkspaces
Lists Workspaces in a given Repository.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { RepositoryName parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]"); for (Workspace element : dataformClient.listWorkspaces(parent).iterateAll()) { // doThingsWith(element); } }- Parameters:
parent- Required. The repository in which to list workspaces. Must be in the format `projects/*/locations/*/repositories/*`.- Throws:
ApiException- if the remote call fails
-
listWorkspaces
Lists Workspaces in a given Repository.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { String parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString(); for (Workspace element : dataformClient.listWorkspaces(parent).iterateAll()) { // doThingsWith(element); } }- Parameters:
parent- Required. The repository in which to list workspaces. Must be in the format `projects/*/locations/*/repositories/*`.- Throws:
ApiException- if the remote call fails
-
listWorkspaces
public final DataformClient.ListWorkspacesPagedResponse listWorkspaces(ListWorkspacesRequest request) Lists Workspaces in a given Repository.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { ListWorkspacesRequest request = ListWorkspacesRequest.newBuilder() .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .build(); for (Workspace element : dataformClient.listWorkspaces(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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); } } -
listWorkspacesCallable
Lists Workspaces in a given Repository.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { ListWorkspacesRequest request = ListWorkspacesRequest.newBuilder() .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .build(); while (true) { ListWorkspacesResponse response = dataformClient.listWorkspacesCallable().call(request); for (Workspace element : response.getWorkspacesList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
getWorkspace
Fetches a single Workspace.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { WorkspaceName name = WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]"); Workspace response = dataformClient.getWorkspace(name); }- Parameters:
name- Required. The workspace's name.- Throws:
ApiException- if the remote call fails
-
getWorkspace
Fetches a single Workspace.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { String name = WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]").toString(); Workspace response = dataformClient.getWorkspace(name); }- Parameters:
name- Required. The workspace's name.- Throws:
ApiException- if the remote call fails
-
getWorkspace
Fetches a single Workspace.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { GetWorkspaceRequest request = GetWorkspaceRequest.newBuilder() .setName( WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]") .toString()) .build(); Workspace response = dataformClient.getWorkspace(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
getWorkspaceCallable
Fetches a single Workspace.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { GetWorkspaceRequest request = GetWorkspaceRequest.newBuilder() .setName( WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]") .toString()) .build(); ApiFuture<Workspace> future = dataformClient.getWorkspaceCallable().futureCall(request); // Do something. Workspace response = future.get(); } -
createWorkspace
public final Workspace createWorkspace(RepositoryName parent, Workspace workspace, String workspaceId) Creates a new Workspace in a given Repository.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { RepositoryName parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]"); Workspace workspace = Workspace.newBuilder().build(); String workspaceId = "workspaceId466560144"; Workspace response = dataformClient.createWorkspace(parent, workspace, workspaceId); }- Parameters:
parent- Required. The repository in which to create the workspace. Must be in the format `projects/*/locations/*/repositories/*`.workspace- Required. The workspace to create.workspaceId- Required. The ID to use for the workspace, which will become the final component of the workspace's resource name.- Throws:
ApiException- if the remote call fails
-
createWorkspace
Creates a new Workspace in a given Repository.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { String parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString(); Workspace workspace = Workspace.newBuilder().build(); String workspaceId = "workspaceId466560144"; Workspace response = dataformClient.createWorkspace(parent, workspace, workspaceId); }- Parameters:
parent- Required. The repository in which to create the workspace. Must be in the format `projects/*/locations/*/repositories/*`.workspace- Required. The workspace to create.workspaceId- Required. The ID to use for the workspace, which will become the final component of the workspace's resource name.- Throws:
ApiException- if the remote call fails
-
createWorkspace
Creates a new Workspace in a given Repository.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { CreateWorkspaceRequest request = CreateWorkspaceRequest.newBuilder() .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setWorkspace(Workspace.newBuilder().build()) .setWorkspaceId("workspaceId466560144") .build(); Workspace response = dataformClient.createWorkspace(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
createWorkspaceCallable
Creates a new Workspace in a given Repository.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { CreateWorkspaceRequest request = CreateWorkspaceRequest.newBuilder() .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setWorkspace(Workspace.newBuilder().build()) .setWorkspaceId("workspaceId466560144") .build(); ApiFuture<Workspace> future = dataformClient.createWorkspaceCallable().futureCall(request); // Do something. Workspace response = future.get(); } -
deleteWorkspace
Deletes a single Workspace.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { WorkspaceName name = WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]"); dataformClient.deleteWorkspace(name); }- Parameters:
name- Required. The workspace resource's name.- Throws:
ApiException- if the remote call fails
-
deleteWorkspace
Deletes a single Workspace.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { String name = WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]").toString(); dataformClient.deleteWorkspace(name); }- Parameters:
name- Required. The workspace resource's name.- Throws:
ApiException- if the remote call fails
-
deleteWorkspace
Deletes a single Workspace.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { DeleteWorkspaceRequest request = DeleteWorkspaceRequest.newBuilder() .setName( WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]") .toString()) .build(); dataformClient.deleteWorkspace(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
deleteWorkspaceCallable
public final UnaryCallable<DeleteWorkspaceRequest,com.google.protobuf.Empty> deleteWorkspaceCallable()Deletes a single Workspace.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { DeleteWorkspaceRequest request = DeleteWorkspaceRequest.newBuilder() .setName( WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]") .toString()) .build(); ApiFuture<Empty> future = dataformClient.deleteWorkspaceCallable().futureCall(request); // Do something. future.get(); } -
installNpmPackages
Installs dependency NPM packages (inside a Workspace).Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { InstallNpmPackagesRequest request = InstallNpmPackagesRequest.newBuilder() .setWorkspace( WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]") .toString()) .build(); InstallNpmPackagesResponse response = dataformClient.installNpmPackages(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
pullGitCommits
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(); PullGitCommitsResponse response = dataformClient.pullGitCommits(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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<PullGitCommitsResponse> future = dataformClient.pullGitCommitsCallable().futureCall(request); // Do something. PullGitCommitsResponse response = future.get(); } -
pushGitCommits
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(); PushGitCommitsResponse response = dataformClient.pushGitCommits(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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<PushGitCommitsResponse> future = dataformClient.pushGitCommitsCallable().futureCall(request); // Do something. PushGitCommitsResponse response = future.get(); } -
fetchFileGitStatuses
Fetches Git statuses for the files in a Workspace.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { FetchFileGitStatusesRequest request = FetchFileGitStatusesRequest.newBuilder() .setName( WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]") .toString()) .build(); FetchFileGitStatusesResponse response = dataformClient.fetchFileGitStatuses(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
fetchGitAheadBehind
Fetches Git ahead/behind against a remote branch.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { FetchGitAheadBehindRequest request = FetchGitAheadBehindRequest.newBuilder() .setName( WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]") .toString()) .setRemoteBranch("remoteBranch-533119608") .build(); FetchGitAheadBehindResponse response = dataformClient.fetchGitAheadBehind(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
commitWorkspaceChanges
public final CommitWorkspaceChangesResponse 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(); CommitWorkspaceChangesResponse response = dataformClient.commitWorkspaceChanges(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
commitWorkspaceChangesCallable
public final UnaryCallable<CommitWorkspaceChangesRequest,CommitWorkspaceChangesResponse> 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<CommitWorkspaceChangesResponse> future = dataformClient.commitWorkspaceChangesCallable().futureCall(request); // Do something. CommitWorkspaceChangesResponse response = future.get(); } -
resetWorkspaceChanges
public final ResetWorkspaceChangesResponse 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(); ResetWorkspaceChangesResponse response = dataformClient.resetWorkspaceChanges(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
resetWorkspaceChangesCallable
public final UnaryCallable<ResetWorkspaceChangesRequest,ResetWorkspaceChangesResponse> 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<ResetWorkspaceChangesResponse> future = dataformClient.resetWorkspaceChangesCallable().futureCall(request); // Do something. ResetWorkspaceChangesResponse response = future.get(); } -
fetchFileDiff
Fetches Git diff for an uncommitted file in a Workspace.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { FetchFileDiffRequest request = FetchFileDiffRequest.newBuilder() .setWorkspace( WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]") .toString()) .setPath("path3433509") .build(); FetchFileDiffResponse response = dataformClient.fetchFileDiff(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
fetchFileDiffCallable
Fetches Git diff for an uncommitted file in a Workspace.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { FetchFileDiffRequest request = FetchFileDiffRequest.newBuilder() .setWorkspace( WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]") .toString()) .setPath("path3433509") .build(); ApiFuture<FetchFileDiffResponse> future = dataformClient.fetchFileDiffCallable().futureCall(request); // Do something. FetchFileDiffResponse response = future.get(); } -
queryDirectoryContents
public final DataformClient.QueryDirectoryContentsPagedResponse queryDirectoryContents(QueryDirectoryContentsRequest request) Returns the contents of a given Workspace directory.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { QueryDirectoryContentsRequest request = QueryDirectoryContentsRequest.newBuilder() .setWorkspace( WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]") .toString()) .setPath("path3433509") .setPageSize(883849137) .setPageToken("pageToken873572522") .setView(DirectoryContentsView.forNumber(0)) .build(); for (DirectoryEntry element : dataformClient.queryDirectoryContents(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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") .setView(DirectoryContentsView.forNumber(0)) .build(); ApiFuture<DirectoryEntry> future = dataformClient.queryDirectoryContentsPagedCallable().futureCall(request); // Do something. for (DirectoryEntry element : future.get().iterateAll()) { // doThingsWith(element); } } -
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") .setView(DirectoryContentsView.forNumber(0)) .build(); while (true) { QueryDirectoryContentsResponse response = dataformClient.queryDirectoryContentsCallable().call(request); for (DirectoryEntry element : response.getDirectoryEntriesList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
searchFiles
Finds the contents of a given Workspace directory by filter.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { SearchFilesRequest request = SearchFilesRequest.newBuilder() .setWorkspace( WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]") .toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .build(); for (SearchResult element : dataformClient.searchFiles(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
searchFilesPagedCallable
public final UnaryCallable<SearchFilesRequest,DataformClient.SearchFilesPagedResponse> searchFilesPagedCallable()Finds the contents of a given Workspace directory by filter.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { SearchFilesRequest request = SearchFilesRequest.newBuilder() .setWorkspace( WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]") .toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .build(); ApiFuture<SearchResult> future = dataformClient.searchFilesPagedCallable().futureCall(request); // Do something. for (SearchResult element : future.get().iterateAll()) { // doThingsWith(element); } } -
searchFilesCallable
Finds the contents of a given Workspace directory by filter.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { SearchFilesRequest request = SearchFilesRequest.newBuilder() .setWorkspace( WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]") .toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .build(); while (true) { SearchFilesResponse response = dataformClient.searchFilesCallable().call(request); for (SearchResult element : response.getSearchResultsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
makeDirectory
Creates a directory inside a Workspace.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { MakeDirectoryRequest request = MakeDirectoryRequest.newBuilder() .setWorkspace( WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]") .toString()) .setPath("path3433509") .build(); MakeDirectoryResponse response = dataformClient.makeDirectory(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
makeDirectoryCallable
Creates a directory inside a Workspace.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { MakeDirectoryRequest request = MakeDirectoryRequest.newBuilder() .setWorkspace( WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]") .toString()) .setPath("path3433509") .build(); ApiFuture<MakeDirectoryResponse> future = dataformClient.makeDirectoryCallable().futureCall(request); // Do something. MakeDirectoryResponse response = future.get(); } -
removeDirectory
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(); RemoveDirectoryResponse response = dataformClient.removeDirectory(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
removeDirectoryCallable
public final UnaryCallable<RemoveDirectoryRequest,RemoveDirectoryResponse> 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<RemoveDirectoryResponse> future = dataformClient.removeDirectoryCallable().futureCall(request); // Do something. RemoveDirectoryResponse response = future.get(); } -
moveDirectory
Moves a directory (inside a Workspace), and all of its contents, to a new location.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { MoveDirectoryRequest request = MoveDirectoryRequest.newBuilder() .setWorkspace( WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]") .toString()) .setPath("path3433509") .setNewPath("newPath1845080549") .build(); MoveDirectoryResponse response = dataformClient.moveDirectory(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
moveDirectoryCallable
Moves a directory (inside a Workspace), and all of its contents, to a new location.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { MoveDirectoryRequest request = MoveDirectoryRequest.newBuilder() .setWorkspace( WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]") .toString()) .setPath("path3433509") .setNewPath("newPath1845080549") .build(); ApiFuture<MoveDirectoryResponse> future = dataformClient.moveDirectoryCallable().futureCall(request); // Do something. MoveDirectoryResponse response = future.get(); } -
readFile
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") .setRevision("revision-260786213") .build(); ReadFileResponse response = dataformClient.readFile(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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") .setRevision("revision-260786213") .build(); ApiFuture<ReadFileResponse> future = dataformClient.readFileCallable().futureCall(request); // Do something. ReadFileResponse response = future.get(); } -
removeFile
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(); RemoveFileResponse response = dataformClient.removeFile(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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<RemoveFileResponse> future = dataformClient.removeFileCallable().futureCall(request); // Do something. RemoveFileResponse response = future.get(); } -
moveFile
Moves a file (inside a Workspace) to a new location.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { MoveFileRequest request = MoveFileRequest.newBuilder() .setWorkspace( WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]") .toString()) .setPath("path3433509") .setNewPath("newPath1845080549") .build(); MoveFileResponse response = dataformClient.moveFile(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
moveFileCallable
Moves a file (inside a Workspace) to a new location.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { MoveFileRequest request = MoveFileRequest.newBuilder() .setWorkspace( WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]") .toString()) .setPath("path3433509") .setNewPath("newPath1845080549") .build(); ApiFuture<MoveFileResponse> future = dataformClient.moveFileCallable().futureCall(request); // Do something. MoveFileResponse response = future.get(); } -
writeFile
Writes to a file (inside a Workspace).Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { WriteFileRequest request = WriteFileRequest.newBuilder() .setWorkspace( WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]") .toString()) .setPath("path3433509") .setContents(ByteString.EMPTY) .build(); WriteFileResponse response = dataformClient.writeFile(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
listReleaseConfigs
public final DataformClient.ListReleaseConfigsPagedResponse listReleaseConfigs(RepositoryName parent) Lists ReleaseConfigs 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 (ReleaseConfig element : dataformClient.listReleaseConfigs(parent).iterateAll()) { // doThingsWith(element); } }- Parameters:
parent- Required. The repository in which to list release configs. Must be in the format `projects/*/locations/*/repositories/*`.- Throws:
ApiException- if the remote call fails
-
listReleaseConfigs
Lists ReleaseConfigs 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 (ReleaseConfig element : dataformClient.listReleaseConfigs(parent).iterateAll()) { // doThingsWith(element); } }- Parameters:
parent- Required. The repository in which to list release configs. Must be in the format `projects/*/locations/*/repositories/*`.- Throws:
ApiException- if the remote call fails
-
listReleaseConfigs
public final DataformClient.ListReleaseConfigsPagedResponse listReleaseConfigs(ListReleaseConfigsRequest request) Lists ReleaseConfigs 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()) { ListReleaseConfigsRequest request = ListReleaseConfigsRequest.newBuilder() .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (ReleaseConfig element : dataformClient.listReleaseConfigs(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
listReleaseConfigsPagedCallable
public final UnaryCallable<ListReleaseConfigsRequest,DataformClient.ListReleaseConfigsPagedResponse> listReleaseConfigsPagedCallable()Lists ReleaseConfigs 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()) { ListReleaseConfigsRequest request = ListReleaseConfigsRequest.newBuilder() .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<ReleaseConfig> future = dataformClient.listReleaseConfigsPagedCallable().futureCall(request); // Do something. for (ReleaseConfig element : future.get().iterateAll()) { // doThingsWith(element); } } -
listReleaseConfigsCallable
public final UnaryCallable<ListReleaseConfigsRequest,ListReleaseConfigsResponse> listReleaseConfigsCallable()Lists ReleaseConfigs 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()) { ListReleaseConfigsRequest request = ListReleaseConfigsRequest.newBuilder() .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListReleaseConfigsResponse response = dataformClient.listReleaseConfigsCallable().call(request); for (ReleaseConfig element : response.getReleaseConfigsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
getReleaseConfig
Fetches a single ReleaseConfig.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { ReleaseConfigName name = ReleaseConfigName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[RELEASE_CONFIG]"); ReleaseConfig response = dataformClient.getReleaseConfig(name); }- Parameters:
name- Required. The release config's name.- Throws:
ApiException- if the remote call fails
-
getReleaseConfig
Fetches a single ReleaseConfig.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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 = ReleaseConfigName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[RELEASE_CONFIG]") .toString(); ReleaseConfig response = dataformClient.getReleaseConfig(name); }- Parameters:
name- Required. The release config's name.- Throws:
ApiException- if the remote call fails
-
getReleaseConfig
Fetches a single ReleaseConfig.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { GetReleaseConfigRequest request = GetReleaseConfigRequest.newBuilder() .setName( ReleaseConfigName.of( "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[RELEASE_CONFIG]") .toString()) .build(); ReleaseConfig response = dataformClient.getReleaseConfig(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
getReleaseConfigCallable
Fetches a single ReleaseConfig.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { GetReleaseConfigRequest request = GetReleaseConfigRequest.newBuilder() .setName( ReleaseConfigName.of( "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[RELEASE_CONFIG]") .toString()) .build(); ApiFuture<ReleaseConfig> future = dataformClient.getReleaseConfigCallable().futureCall(request); // Do something. ReleaseConfig response = future.get(); } -
createReleaseConfig
public final ReleaseConfig createReleaseConfig(RepositoryName parent, ReleaseConfig releaseConfig, String releaseConfigId) Creates a new ReleaseConfig 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]"); ReleaseConfig releaseConfig = ReleaseConfig.newBuilder().build(); String releaseConfigId = "releaseConfigId1350457636"; ReleaseConfig response = dataformClient.createReleaseConfig(parent, releaseConfig, releaseConfigId); }- Parameters:
parent- Required. The repository in which to create the release config. Must be in the format `projects/*/locations/*/repositories/*`.releaseConfig- Required. The release config to create.releaseConfigId- Required. The ID to use for the release config, which will become the final component of the release config's resource name.- Throws:
ApiException- if the remote call fails
-
createReleaseConfig
public final ReleaseConfig createReleaseConfig(String parent, ReleaseConfig releaseConfig, String releaseConfigId) Creates a new ReleaseConfig 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(); ReleaseConfig releaseConfig = ReleaseConfig.newBuilder().build(); String releaseConfigId = "releaseConfigId1350457636"; ReleaseConfig response = dataformClient.createReleaseConfig(parent, releaseConfig, releaseConfigId); }- Parameters:
parent- Required. The repository in which to create the release config. Must be in the format `projects/*/locations/*/repositories/*`.releaseConfig- Required. The release config to create.releaseConfigId- Required. The ID to use for the release config, which will become the final component of the release config's resource name.- Throws:
ApiException- if the remote call fails
-
createReleaseConfig
Creates a new ReleaseConfig 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()) { CreateReleaseConfigRequest request = CreateReleaseConfigRequest.newBuilder() .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setReleaseConfig(ReleaseConfig.newBuilder().build()) .setReleaseConfigId("releaseConfigId1350457636") .build(); ReleaseConfig response = dataformClient.createReleaseConfig(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
createReleaseConfigCallable
Creates a new ReleaseConfig 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()) { CreateReleaseConfigRequest request = CreateReleaseConfigRequest.newBuilder() .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setReleaseConfig(ReleaseConfig.newBuilder().build()) .setReleaseConfigId("releaseConfigId1350457636") .build(); ApiFuture<ReleaseConfig> future = dataformClient.createReleaseConfigCallable().futureCall(request); // Do something. ReleaseConfig response = future.get(); } -
updateReleaseConfig
public final ReleaseConfig updateReleaseConfig(ReleaseConfig releaseConfig, com.google.protobuf.FieldMask updateMask) Updates a single ReleaseConfig.**Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { ReleaseConfig releaseConfig = ReleaseConfig.newBuilder().build(); FieldMask updateMask = FieldMask.newBuilder().build(); ReleaseConfig response = dataformClient.updateReleaseConfig(releaseConfig, updateMask); }- Parameters:
releaseConfig- Required. The release config to update.updateMask- Optional. Specifies the fields to be updated in the release config. If left unset, all fields will be updated.- Throws:
ApiException- if the remote call fails
-
updateReleaseConfig
Updates a single ReleaseConfig.**Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { UpdateReleaseConfigRequest request = UpdateReleaseConfigRequest.newBuilder() .setUpdateMask(FieldMask.newBuilder().build()) .setReleaseConfig(ReleaseConfig.newBuilder().build()) .build(); ReleaseConfig response = dataformClient.updateReleaseConfig(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
updateReleaseConfigCallable
Updates a single ReleaseConfig.**Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { UpdateReleaseConfigRequest request = UpdateReleaseConfigRequest.newBuilder() .setUpdateMask(FieldMask.newBuilder().build()) .setReleaseConfig(ReleaseConfig.newBuilder().build()) .build(); ApiFuture<ReleaseConfig> future = dataformClient.updateReleaseConfigCallable().futureCall(request); // Do something. ReleaseConfig response = future.get(); } -
deleteReleaseConfig
Deletes a single ReleaseConfig.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { ReleaseConfigName name = ReleaseConfigName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[RELEASE_CONFIG]"); dataformClient.deleteReleaseConfig(name); }- Parameters:
name- Required. The release config's name.- Throws:
ApiException- if the remote call fails
-
deleteReleaseConfig
Deletes a single ReleaseConfig.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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 = ReleaseConfigName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[RELEASE_CONFIG]") .toString(); dataformClient.deleteReleaseConfig(name); }- Parameters:
name- Required. The release config's name.- Throws:
ApiException- if the remote call fails
-
deleteReleaseConfig
Deletes a single ReleaseConfig.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { DeleteReleaseConfigRequest request = DeleteReleaseConfigRequest.newBuilder() .setName( ReleaseConfigName.of( "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[RELEASE_CONFIG]") .toString()) .build(); dataformClient.deleteReleaseConfig(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
deleteReleaseConfigCallable
public final UnaryCallable<DeleteReleaseConfigRequest,com.google.protobuf.Empty> deleteReleaseConfigCallable()Deletes a single ReleaseConfig.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { DeleteReleaseConfigRequest request = DeleteReleaseConfigRequest.newBuilder() .setName( ReleaseConfigName.of( "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[RELEASE_CONFIG]") .toString()) .build(); ApiFuture<Empty> future = dataformClient.deleteReleaseConfigCallable().futureCall(request); // Do something. future.get(); } -
listCompilationResults
public final DataformClient.ListCompilationResultsPagedResponse listCompilationResults(RepositoryName parent) Lists CompilationResults in a given Repository.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { RepositoryName parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]"); for (CompilationResult element : dataformClient.listCompilationResults(parent).iterateAll()) { // doThingsWith(element); } }- Parameters:
parent- Required. The repository in which to list compilation results. Must be in the format `projects/*/locations/*/repositories/*`.- Throws:
ApiException- if the remote call fails
-
listCompilationResults
public final DataformClient.ListCompilationResultsPagedResponse listCompilationResults(String parent) Lists CompilationResults in a given Repository.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { String parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString(); for (CompilationResult element : dataformClient.listCompilationResults(parent).iterateAll()) { // doThingsWith(element); } }- Parameters:
parent- Required. The repository in which to list compilation results. Must be in the format `projects/*/locations/*/repositories/*`.- Throws:
ApiException- if the remote call fails
-
listCompilationResults
public final DataformClient.ListCompilationResultsPagedResponse listCompilationResults(ListCompilationResultsRequest request) Lists CompilationResults in a given Repository.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { ListCompilationResultsRequest request = ListCompilationResultsRequest.newBuilder() .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .build(); for (CompilationResult element : dataformClient.listCompilationResults(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .build(); ApiFuture<CompilationResult> future = dataformClient.listCompilationResultsPagedCallable().futureCall(request); // Do something. for (CompilationResult element : future.get().iterateAll()) { // doThingsWith(element); } } -
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") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .build(); while (true) { ListCompilationResultsResponse response = dataformClient.listCompilationResultsCallable().call(request); for (CompilationResult element : response.getCompilationResultsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
getCompilationResult
Fetches a single CompilationResult.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { CompilationResultName name = CompilationResultName.of( "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[COMPILATION_RESULT]"); CompilationResult response = dataformClient.getCompilationResult(name); }- Parameters:
name- Required. The compilation result's name.- Throws:
ApiException- if the remote call fails
-
getCompilationResult
Fetches a single CompilationResult.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { String name = CompilationResultName.of( "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[COMPILATION_RESULT]") .toString(); CompilationResult response = dataformClient.getCompilationResult(name); }- Parameters:
name- Required. The compilation result's name.- Throws:
ApiException- if the remote call fails
-
getCompilationResult
Fetches a single CompilationResult.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { GetCompilationResultRequest request = GetCompilationResultRequest.newBuilder() .setName( CompilationResultName.of( "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[COMPILATION_RESULT]") .toString()) .build(); CompilationResult response = dataformClient.getCompilationResult(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
createCompilationResult
public final CompilationResult createCompilationResult(RepositoryName parent, CompilationResult compilationResult) Creates a new CompilationResult in a given project and location.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { RepositoryName parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]"); CompilationResult compilationResult = CompilationResult.newBuilder().build(); CompilationResult response = dataformClient.createCompilationResult(parent, compilationResult); }- Parameters:
parent- Required. The repository in which to create the compilation result. Must be in the format `projects/*/locations/*/repositories/*`.compilationResult- Required. The compilation result to create.- Throws:
ApiException- if the remote call fails
-
createCompilationResult
public final CompilationResult createCompilationResult(String parent, CompilationResult compilationResult) Creates a new CompilationResult in a given project and location.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { String parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString(); CompilationResult compilationResult = CompilationResult.newBuilder().build(); CompilationResult response = dataformClient.createCompilationResult(parent, compilationResult); }- Parameters:
parent- Required. The repository in which to create the compilation result. Must be in the format `projects/*/locations/*/repositories/*`.compilationResult- Required. The compilation result to create.- Throws:
ApiException- if the remote call fails
-
createCompilationResult
Creates a new CompilationResult in a given project and location.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { CreateCompilationResultRequest request = CreateCompilationResultRequest.newBuilder() .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setCompilationResult(CompilationResult.newBuilder().build()) .build(); CompilationResult response = dataformClient.createCompilationResult(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
queryCompilationResultActions
public final DataformClient.QueryCompilationResultActionsPagedResponse queryCompilationResultActions(QueryCompilationResultActionsRequest request) Returns CompilationResultActions in a given CompilationResult.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { QueryCompilationResultActionsRequest request = QueryCompilationResultActionsRequest.newBuilder() .setName( CompilationResultName.of( "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[COMPILATION_RESULT]") .toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .build(); for (CompilationResultAction element : dataformClient.queryCompilationResultActions(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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); } } -
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; } } } -
listWorkflowConfigs
public final DataformClient.ListWorkflowConfigsPagedResponse listWorkflowConfigs(RepositoryName parent) Lists WorkflowConfigs 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 (WorkflowConfig element : dataformClient.listWorkflowConfigs(parent).iterateAll()) { // doThingsWith(element); } }- Parameters:
parent- Required. The repository in which to list workflow configs. Must be in the format `projects/*/locations/*/repositories/*`.- Throws:
ApiException- if the remote call fails
-
listWorkflowConfigs
Lists WorkflowConfigs 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 (WorkflowConfig element : dataformClient.listWorkflowConfigs(parent).iterateAll()) { // doThingsWith(element); } }- Parameters:
parent- Required. The repository in which to list workflow configs. Must be in the format `projects/*/locations/*/repositories/*`.- Throws:
ApiException- if the remote call fails
-
listWorkflowConfigs
public final DataformClient.ListWorkflowConfigsPagedResponse listWorkflowConfigs(ListWorkflowConfigsRequest request) Lists WorkflowConfigs 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()) { ListWorkflowConfigsRequest request = ListWorkflowConfigsRequest.newBuilder() .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (WorkflowConfig element : dataformClient.listWorkflowConfigs(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
listWorkflowConfigsPagedCallable
public final UnaryCallable<ListWorkflowConfigsRequest,DataformClient.ListWorkflowConfigsPagedResponse> listWorkflowConfigsPagedCallable()Lists WorkflowConfigs 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()) { ListWorkflowConfigsRequest request = ListWorkflowConfigsRequest.newBuilder() .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<WorkflowConfig> future = dataformClient.listWorkflowConfigsPagedCallable().futureCall(request); // Do something. for (WorkflowConfig element : future.get().iterateAll()) { // doThingsWith(element); } } -
listWorkflowConfigsCallable
public final UnaryCallable<ListWorkflowConfigsRequest,ListWorkflowConfigsResponse> listWorkflowConfigsCallable()Lists WorkflowConfigs 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()) { ListWorkflowConfigsRequest request = ListWorkflowConfigsRequest.newBuilder() .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListWorkflowConfigsResponse response = dataformClient.listWorkflowConfigsCallable().call(request); for (WorkflowConfig element : response.getWorkflowConfigsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
getWorkflowConfig
Fetches a single WorkflowConfig.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { WorkflowConfigName name = WorkflowConfigName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_CONFIG]"); WorkflowConfig response = dataformClient.getWorkflowConfig(name); }- Parameters:
name- Required. The workflow config's name.- Throws:
ApiException- if the remote call fails
-
getWorkflowConfig
Fetches a single WorkflowConfig.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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 = WorkflowConfigName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_CONFIG]") .toString(); WorkflowConfig response = dataformClient.getWorkflowConfig(name); }- Parameters:
name- Required. The workflow config's name.- Throws:
ApiException- if the remote call fails
-
getWorkflowConfig
Fetches a single WorkflowConfig.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { GetWorkflowConfigRequest request = GetWorkflowConfigRequest.newBuilder() .setName( WorkflowConfigName.of( "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_CONFIG]") .toString()) .build(); WorkflowConfig response = dataformClient.getWorkflowConfig(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
getWorkflowConfigCallable
Fetches a single WorkflowConfig.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { GetWorkflowConfigRequest request = GetWorkflowConfigRequest.newBuilder() .setName( WorkflowConfigName.of( "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_CONFIG]") .toString()) .build(); ApiFuture<WorkflowConfig> future = dataformClient.getWorkflowConfigCallable().futureCall(request); // Do something. WorkflowConfig response = future.get(); } -
createWorkflowConfig
public final WorkflowConfig createWorkflowConfig(RepositoryName parent, WorkflowConfig workflowConfig, String workflowConfigId) Creates a new WorkflowConfig 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]"); WorkflowConfig workflowConfig = WorkflowConfig.newBuilder().build(); String workflowConfigId = "workflowConfigId-1331048228"; WorkflowConfig response = dataformClient.createWorkflowConfig(parent, workflowConfig, workflowConfigId); }- Parameters:
parent- Required. The repository in which to create the workflow config. Must be in the format `projects/*/locations/*/repositories/*`.workflowConfig- Required. The workflow config to create.workflowConfigId- Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.- Throws:
ApiException- if the remote call fails
-
createWorkflowConfig
public final WorkflowConfig createWorkflowConfig(String parent, WorkflowConfig workflowConfig, String workflowConfigId) Creates a new WorkflowConfig 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(); WorkflowConfig workflowConfig = WorkflowConfig.newBuilder().build(); String workflowConfigId = "workflowConfigId-1331048228"; WorkflowConfig response = dataformClient.createWorkflowConfig(parent, workflowConfig, workflowConfigId); }- Parameters:
parent- Required. The repository in which to create the workflow config. Must be in the format `projects/*/locations/*/repositories/*`.workflowConfig- Required. The workflow config to create.workflowConfigId- Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.- Throws:
ApiException- if the remote call fails
-
createWorkflowConfig
Creates a new WorkflowConfig 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()) { CreateWorkflowConfigRequest request = CreateWorkflowConfigRequest.newBuilder() .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setWorkflowConfig(WorkflowConfig.newBuilder().build()) .setWorkflowConfigId("workflowConfigId-1331048228") .build(); WorkflowConfig response = dataformClient.createWorkflowConfig(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
createWorkflowConfigCallable
public final UnaryCallable<CreateWorkflowConfigRequest,WorkflowConfig> createWorkflowConfigCallable()Creates a new WorkflowConfig 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()) { CreateWorkflowConfigRequest request = CreateWorkflowConfigRequest.newBuilder() .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setWorkflowConfig(WorkflowConfig.newBuilder().build()) .setWorkflowConfigId("workflowConfigId-1331048228") .build(); ApiFuture<WorkflowConfig> future = dataformClient.createWorkflowConfigCallable().futureCall(request); // Do something. WorkflowConfig response = future.get(); } -
updateWorkflowConfig
public final WorkflowConfig updateWorkflowConfig(WorkflowConfig workflowConfig, com.google.protobuf.FieldMask updateMask) Updates a single WorkflowConfig.**Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { WorkflowConfig workflowConfig = WorkflowConfig.newBuilder().build(); FieldMask updateMask = FieldMask.newBuilder().build(); WorkflowConfig response = dataformClient.updateWorkflowConfig(workflowConfig, updateMask); }- Parameters:
workflowConfig- Required. The workflow config to update.updateMask- Optional. Specifies the fields to be updated in the workflow config. If left unset, all fields will be updated.- Throws:
ApiException- if the remote call fails
-
updateWorkflowConfig
Updates a single WorkflowConfig.**Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { UpdateWorkflowConfigRequest request = UpdateWorkflowConfigRequest.newBuilder() .setUpdateMask(FieldMask.newBuilder().build()) .setWorkflowConfig(WorkflowConfig.newBuilder().build()) .build(); WorkflowConfig response = dataformClient.updateWorkflowConfig(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
updateWorkflowConfigCallable
public final UnaryCallable<UpdateWorkflowConfigRequest,WorkflowConfig> updateWorkflowConfigCallable()Updates a single WorkflowConfig.**Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { UpdateWorkflowConfigRequest request = UpdateWorkflowConfigRequest.newBuilder() .setUpdateMask(FieldMask.newBuilder().build()) .setWorkflowConfig(WorkflowConfig.newBuilder().build()) .build(); ApiFuture<WorkflowConfig> future = dataformClient.updateWorkflowConfigCallable().futureCall(request); // Do something. WorkflowConfig response = future.get(); } -
deleteWorkflowConfig
Deletes a single WorkflowConfig.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { WorkflowConfigName name = WorkflowConfigName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_CONFIG]"); dataformClient.deleteWorkflowConfig(name); }- Parameters:
name- Required. The workflow config's name.- Throws:
ApiException- if the remote call fails
-
deleteWorkflowConfig
Deletes a single WorkflowConfig.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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 = WorkflowConfigName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_CONFIG]") .toString(); dataformClient.deleteWorkflowConfig(name); }- Parameters:
name- Required. The workflow config's name.- Throws:
ApiException- if the remote call fails
-
deleteWorkflowConfig
Deletes a single WorkflowConfig.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { DeleteWorkflowConfigRequest request = DeleteWorkflowConfigRequest.newBuilder() .setName( WorkflowConfigName.of( "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_CONFIG]") .toString()) .build(); dataformClient.deleteWorkflowConfig(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
deleteWorkflowConfigCallable
public final UnaryCallable<DeleteWorkflowConfigRequest,com.google.protobuf.Empty> deleteWorkflowConfigCallable()Deletes a single WorkflowConfig.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { DeleteWorkflowConfigRequest request = DeleteWorkflowConfigRequest.newBuilder() .setName( WorkflowConfigName.of( "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_CONFIG]") .toString()) .build(); ApiFuture<Empty> future = dataformClient.deleteWorkflowConfigCallable().futureCall(request); // Do something. future.get(); } -
listWorkflowInvocations
public final DataformClient.ListWorkflowInvocationsPagedResponse listWorkflowInvocations(RepositoryName parent) Lists WorkflowInvocations in a given Repository.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { RepositoryName parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]"); for (WorkflowInvocation element : dataformClient.listWorkflowInvocations(parent).iterateAll()) { // doThingsWith(element); } }- Parameters:
parent- Required. The parent resource of the WorkflowInvocation type. Must be in the format `projects/*/locations/*/repositories/*`.- Throws:
ApiException- if the remote call fails
-
listWorkflowInvocations
public final DataformClient.ListWorkflowInvocationsPagedResponse listWorkflowInvocations(String parent) Lists WorkflowInvocations in a given Repository.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { String parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString(); for (WorkflowInvocation element : dataformClient.listWorkflowInvocations(parent).iterateAll()) { // doThingsWith(element); } }- Parameters:
parent- Required. The parent resource of the WorkflowInvocation type. Must be in the format `projects/*/locations/*/repositories/*`.- Throws:
ApiException- if the remote call fails
-
listWorkflowInvocations
public final DataformClient.ListWorkflowInvocationsPagedResponse listWorkflowInvocations(ListWorkflowInvocationsRequest request) Lists WorkflowInvocations in a given Repository.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { ListWorkflowInvocationsRequest request = ListWorkflowInvocationsRequest.newBuilder() .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .build(); for (WorkflowInvocation element : dataformClient.listWorkflowInvocations(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .build(); ApiFuture<WorkflowInvocation> future = dataformClient.listWorkflowInvocationsPagedCallable().futureCall(request); // Do something. for (WorkflowInvocation element : future.get().iterateAll()) { // doThingsWith(element); } } -
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") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .build(); while (true) { ListWorkflowInvocationsResponse response = dataformClient.listWorkflowInvocationsCallable().call(request); for (WorkflowInvocation element : response.getWorkflowInvocationsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
getWorkflowInvocation
Fetches a single WorkflowInvocation.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { WorkflowInvocationName name = WorkflowInvocationName.of( "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]"); WorkflowInvocation response = dataformClient.getWorkflowInvocation(name); }- Parameters:
name- Required. The workflow invocation resource's name.- Throws:
ApiException- if the remote call fails
-
getWorkflowInvocation
Fetches a single WorkflowInvocation.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { String name = WorkflowInvocationName.of( "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]") .toString(); WorkflowInvocation response = dataformClient.getWorkflowInvocation(name); }- Parameters:
name- Required. The workflow invocation resource's name.- Throws:
ApiException- if the remote call fails
-
getWorkflowInvocation
Fetches a single WorkflowInvocation.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { GetWorkflowInvocationRequest request = GetWorkflowInvocationRequest.newBuilder() .setName( WorkflowInvocationName.of( "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]") .toString()) .build(); WorkflowInvocation response = dataformClient.getWorkflowInvocation(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
createWorkflowInvocation
public final WorkflowInvocation createWorkflowInvocation(RepositoryName parent, WorkflowInvocation workflowInvocation) Creates a new WorkflowInvocation in a given Repository.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { RepositoryName parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]"); WorkflowInvocation workflowInvocation = WorkflowInvocation.newBuilder().build(); WorkflowInvocation response = dataformClient.createWorkflowInvocation(parent, workflowInvocation); }- Parameters:
parent- Required. The repository in which to create the workflow invocation. Must be in the format `projects/*/locations/*/repositories/*`.workflowInvocation- Required. The workflow invocation resource to create.- Throws:
ApiException- if the remote call fails
-
createWorkflowInvocation
public final WorkflowInvocation createWorkflowInvocation(String parent, WorkflowInvocation workflowInvocation) Creates a new WorkflowInvocation in a given Repository.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { String parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString(); WorkflowInvocation workflowInvocation = WorkflowInvocation.newBuilder().build(); WorkflowInvocation response = dataformClient.createWorkflowInvocation(parent, workflowInvocation); }- Parameters:
parent- Required. The repository in which to create the workflow invocation. Must be in the format `projects/*/locations/*/repositories/*`.workflowInvocation- Required. The workflow invocation resource to create.- Throws:
ApiException- if the remote call fails
-
createWorkflowInvocation
Creates a new WorkflowInvocation in a given Repository.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { CreateWorkflowInvocationRequest request = CreateWorkflowInvocationRequest.newBuilder() .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString()) .setWorkflowInvocation(WorkflowInvocation.newBuilder().build()) .build(); WorkflowInvocation response = dataformClient.createWorkflowInvocation(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
deleteWorkflowInvocation
Deletes a single WorkflowInvocation.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { WorkflowInvocationName name = WorkflowInvocationName.of( "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]"); dataformClient.deleteWorkflowInvocation(name); }- Parameters:
name- Required. The workflow invocation resource's name.- Throws:
ApiException- if the remote call fails
-
deleteWorkflowInvocation
Deletes a single WorkflowInvocation.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { String name = WorkflowInvocationName.of( "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]") .toString(); dataformClient.deleteWorkflowInvocation(name); }- Parameters:
name- Required. The workflow invocation resource's name.- Throws:
ApiException- if the remote call fails
-
deleteWorkflowInvocation
Deletes a single WorkflowInvocation.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { DeleteWorkflowInvocationRequest request = DeleteWorkflowInvocationRequest.newBuilder() .setName( WorkflowInvocationName.of( "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]") .toString()) .build(); dataformClient.deleteWorkflowInvocation(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
deleteWorkflowInvocationCallable
public final UnaryCallable<DeleteWorkflowInvocationRequest,com.google.protobuf.Empty> deleteWorkflowInvocationCallable()Deletes a single WorkflowInvocation.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { DeleteWorkflowInvocationRequest request = DeleteWorkflowInvocationRequest.newBuilder() .setName( WorkflowInvocationName.of( "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]") .toString()) .build(); ApiFuture<Empty> future = dataformClient.deleteWorkflowInvocationCallable().futureCall(request); // Do something. future.get(); } -
cancelWorkflowInvocation
public final CancelWorkflowInvocationResponse 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(); CancelWorkflowInvocationResponse response = dataformClient.cancelWorkflowInvocation(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
cancelWorkflowInvocationCallable
public final UnaryCallable<CancelWorkflowInvocationRequest,CancelWorkflowInvocationResponse> 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<CancelWorkflowInvocationResponse> future = dataformClient.cancelWorkflowInvocationCallable().futureCall(request); // Do something. CancelWorkflowInvocationResponse response = future.get(); } -
queryWorkflowInvocationActions
public final DataformClient.QueryWorkflowInvocationActionsPagedResponse queryWorkflowInvocationActions(QueryWorkflowInvocationActionsRequest request) Returns WorkflowInvocationActions in a given WorkflowInvocation.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { QueryWorkflowInvocationActionsRequest request = QueryWorkflowInvocationActionsRequest.newBuilder() .setName( WorkflowInvocationName.of( "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]") .toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (WorkflowInvocationAction element : dataformClient.queryWorkflowInvocationActions(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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); } } -
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; } } } -
getConfig
Get default config for 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()) { ConfigName name = ConfigName.of("[PROJECT]", "[LOCATION]"); Config response = dataformClient.getConfig(name); }- Parameters:
name- Required. The config name.- Throws:
ApiException- if the remote call fails
-
getConfig
Get default config for 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 name = ConfigName.of("[PROJECT]", "[LOCATION]").toString(); Config response = dataformClient.getConfig(name); }- Parameters:
name- Required. The config name.- Throws:
ApiException- if the remote call fails
-
getConfig
Get default config for 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()) { GetConfigRequest request = GetConfigRequest.newBuilder() .setName(ConfigName.of("[PROJECT]", "[LOCATION]").toString()) .build(); Config response = dataformClient.getConfig(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
getConfigCallable
Get default config for 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()) { GetConfigRequest request = GetConfigRequest.newBuilder() .setName(ConfigName.of("[PROJECT]", "[LOCATION]").toString()) .build(); ApiFuture<Config> future = dataformClient.getConfigCallable().futureCall(request); // Do something. Config response = future.get(); } -
updateConfig
Update default config for a given project and location.**Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { Config config = Config.newBuilder().build(); FieldMask updateMask = FieldMask.newBuilder().build(); Config response = dataformClient.updateConfig(config, updateMask); }- Parameters:
config- Required. The config to update.updateMask- Optional. Specifies the fields to be updated in the config.- Throws:
ApiException- if the remote call fails
-
updateConfig
Update default config for a given project and location.**Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { UpdateConfigRequest request = UpdateConfigRequest.newBuilder() .setConfig(Config.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); Config response = dataformClient.updateConfig(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
updateConfigCallable
Update default config for a given project and location.**Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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()) { UpdateConfigRequest request = UpdateConfigRequest.newBuilder() .setConfig(Config.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); ApiFuture<Config> future = dataformClient.updateConfigCallable().futureCall(request); // Do something. Config response = future.get(); } -
getIamPolicy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { ResourceName resource = FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]"); Policy response = dataformClient.getIamPolicy(resource); }- Parameters:
resource- REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.- Throws:
ApiException- if the remote call fails
-
getIamPolicy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { String resource = CompilationResultName.of( "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[COMPILATION_RESULT]") .toString(); Policy response = dataformClient.getIamPolicy(resource); }- Parameters:
resource- REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.- Throws:
ApiException- if the remote call fails
-
getIamPolicy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder() .setResource(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString()) .setOptions(GetPolicyOptions.newBuilder().build()) .build(); Policy response = dataformClient.getIamPolicy(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
getIamPolicyCallable
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder() .setResource(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString()) .setOptions(GetPolicyOptions.newBuilder().build()) .build(); ApiFuture<Policy> future = dataformClient.getIamPolicyCallable().futureCall(request); // Do something. Policy response = future.get(); } -
setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy.Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder() .setResource(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString()) .setPolicy(Policy.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); Policy response = dataformClient.setIamPolicy(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
setIamPolicyCallable
Sets the access control policy on the specified resource. Replaces any existing policy.Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder() .setResource(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString()) .setPolicy(Policy.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); ApiFuture<Policy> future = dataformClient.setIamPolicyCallable().futureCall(request); // Do something. Policy response = future.get(); } -
testIamPermissions
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder() .setResource(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString()) .addAllPermissions(new ArrayList<String>()) .build(); TestIamPermissionsResponse response = dataformClient.testIamPermissions(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
testIamPermissionsCallable
public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder() .setResource(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString()) .addAllPermissions(new ArrayList<String>()) .build(); ApiFuture<TestIamPermissionsResponse> future = dataformClient.testIamPermissionsCallable().futureCall(request); // Do something. TestIamPermissionsResponse response = future.get(); } -
listLocations
Lists information about the supported locations for this service.This method lists locations based on the resource scope provided inthe [ListLocationsRequest.name] field:
* **Global locations**: If `name` is empty, the method lists thepublic locations available to all projects. * **Project-specificlocations**: If `name` follows the format`projects/{project}`, the method lists locations visible to thatspecific project. This includes public, private, or otherproject-specific locations enabled for the project.
For gRPC and client library implementations, the resource name ispassed as the `name` field. For direct service calls, the resourcename isincorporated into the request path based on the specific serviceimplementation and version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (Location element : dataformClient.listLocations(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
listLocationsPagedCallable
public final UnaryCallable<ListLocationsRequest,DataformClient.ListLocationsPagedResponse> listLocationsPagedCallable()Lists information about the supported locations for this service.This method lists locations based on the resource scope provided inthe [ListLocationsRequest.name] field:
* **Global locations**: If `name` is empty, the method lists thepublic locations available to all projects. * **Project-specificlocations**: If `name` follows the format`projects/{project}`, the method lists locations visible to thatspecific project. This includes public, private, or otherproject-specific locations enabled for the project.
For gRPC and client library implementations, the resource name ispassed as the `name` field. For direct service calls, the resourcename isincorporated into the request path based on the specific serviceimplementation and version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<Location> future = dataformClient.listLocationsPagedCallable().futureCall(request); // Do something. for (Location element : future.get().iterateAll()) { // doThingsWith(element); } } -
listLocationsCallable
Lists information about the supported locations for this service.This method lists locations based on the resource scope provided inthe [ListLocationsRequest.name] field:
* **Global locations**: If `name` is empty, the method lists thepublic locations available to all projects. * **Project-specificlocations**: If `name` follows the format`projects/{project}`, the method lists locations visible to thatspecific project. This includes public, private, or otherproject-specific locations enabled for the project.
For gRPC and client library implementations, the resource name ispassed as the `name` field. For direct service calls, the resourcename isincorporated into the request path based on the specific serviceimplementation and version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListLocationsResponse response = dataformClient.listLocationsCallable().call(request); for (Location element : response.getLocationsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
getLocation
Gets information about a location.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DataformClient dataformClient = DataformClient.create()) { GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build(); Location response = dataformClient.getLocation(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
close
public final void close()- Specified by:
closein interfaceAutoCloseable
-
shutdown
public void shutdown()- Specified by:
shutdownin interfaceBackgroundResource
-
isShutdown
public boolean isShutdown()- Specified by:
isShutdownin interfaceBackgroundResource
-
isTerminated
public boolean isTerminated()- Specified by:
isTerminatedin interfaceBackgroundResource
-
shutdownNow
public void shutdownNow()- Specified by:
shutdownNowin interfaceBackgroundResource
-
awaitTermination
- Specified by:
awaitTerminationin interfaceBackgroundResource- Throws:
InterruptedException
-