Reference documentation and code samples for the Google Cloud Dataform V1beta1 Client class DataformClient.
Service Description: Dataform is a service to develop, create, document, test, and update curated tables in BigQuery.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
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 parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
Namespace
Google \ Cloud \ Dataform \ V1beta1 \ ClientMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
options |
array|Google\ApiCore\Options\ClientOptions
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
FetchAuthTokenInterface|CredentialsWrapper
This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
↳ logger |
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
↳ universeDomain |
string
The service domain for the client. Defaults to 'googleapis.com'. |
cancelWorkflowInvocation
Requests cancellation of a running WorkflowInvocation.
The async variant is DataformClient::cancelWorkflowInvocationAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\CancelWorkflowInvocationRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\CancelWorkflowInvocationResponse |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\CancelWorkflowInvocationRequest;
use Google\Cloud\Dataform\V1beta1\CancelWorkflowInvocationResponse;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
/**
* @param string $formattedName The workflow invocation resource's name. Please see
* {@see DataformClient::workflowInvocationName()} for help formatting this field.
*/
function cancel_workflow_invocation_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new CancelWorkflowInvocationRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var CancelWorkflowInvocationResponse $response */
$response = $dataformClient->cancelWorkflowInvocation($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::workflowInvocationName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[WORKFLOW_INVOCATION]'
);
cancel_workflow_invocation_sample($formattedName);
}
commitRepositoryChanges
Applies a Git commit to a Repository. The Repository must not have a value
for git_remote_settings.url.
The async variant is DataformClient::commitRepositoryChangesAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\CommitRepositoryChangesRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\CommitRepositoryChangesResponse |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\CommitAuthor;
use Google\Cloud\Dataform\V1beta1\CommitMetadata;
use Google\Cloud\Dataform\V1beta1\CommitRepositoryChangesRequest;
use Google\Cloud\Dataform\V1beta1\CommitRepositoryChangesResponse;
/**
* @param string $formattedName The repository's name. Please see
* {@see DataformClient::repositoryName()} for help formatting this field.
* @param string $commitMetadataAuthorName The commit author's name.
* @param string $commitMetadataAuthorEmailAddress The commit author's email address.
*/
function commit_repository_changes_sample(
string $formattedName,
string $commitMetadataAuthorName,
string $commitMetadataAuthorEmailAddress
): void {
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$commitMetadataAuthor = (new CommitAuthor())
->setName($commitMetadataAuthorName)
->setEmailAddress($commitMetadataAuthorEmailAddress);
$commitMetadata = (new CommitMetadata())
->setAuthor($commitMetadataAuthor);
$request = (new CommitRepositoryChangesRequest())
->setName($formattedName)
->setCommitMetadata($commitMetadata);
// Call the API and handle any network failures.
try {
/** @var CommitRepositoryChangesResponse $response */
$response = $dataformClient->commitRepositoryChanges($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]');
$commitMetadataAuthorName = '[NAME]';
$commitMetadataAuthorEmailAddress = '[EMAIL_ADDRESS]';
commit_repository_changes_sample(
$formattedName,
$commitMetadataAuthorName,
$commitMetadataAuthorEmailAddress
);
}
commitWorkspaceChanges
Applies a Git commit for uncommitted files in a Workspace.
The async variant is DataformClient::commitWorkspaceChangesAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\CommitWorkspaceChangesRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\CommitWorkspaceChangesResponse |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\CommitAuthor;
use Google\Cloud\Dataform\V1beta1\CommitWorkspaceChangesRequest;
use Google\Cloud\Dataform\V1beta1\CommitWorkspaceChangesResponse;
/**
* @param string $formattedName The workspace's name. Please see
* {@see DataformClient::workspaceName()} for help formatting this field.
* @param string $authorName The commit author's name.
* @param string $authorEmailAddress The commit author's email address.
*/
function commit_workspace_changes_sample(
string $formattedName,
string $authorName,
string $authorEmailAddress
): void {
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$author = (new CommitAuthor())
->setName($authorName)
->setEmailAddress($authorEmailAddress);
$request = (new CommitWorkspaceChangesRequest())
->setName($formattedName)
->setAuthor($author);
// Call the API and handle any network failures.
try {
/** @var CommitWorkspaceChangesResponse $response */
$response = $dataformClient->commitWorkspaceChanges($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::workspaceName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[WORKSPACE]'
);
$authorName = '[NAME]';
$authorEmailAddress = '[EMAIL_ADDRESS]';
commit_workspace_changes_sample($formattedName, $authorName, $authorEmailAddress);
}
computeRepositoryAccessTokenStatus
Computes a Repository's Git access token status.
The async variant is DataformClient::computeRepositoryAccessTokenStatusAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\ComputeRepositoryAccessTokenStatusRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\ComputeRepositoryAccessTokenStatusResponse |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\ComputeRepositoryAccessTokenStatusRequest;
use Google\Cloud\Dataform\V1beta1\ComputeRepositoryAccessTokenStatusResponse;
/**
* @param string $formattedName The repository's name. Please see
* {@see DataformClient::repositoryName()} for help formatting this field.
*/
function compute_repository_access_token_status_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new ComputeRepositoryAccessTokenStatusRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var ComputeRepositoryAccessTokenStatusResponse $response */
$response = $dataformClient->computeRepositoryAccessTokenStatus($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]');
compute_repository_access_token_status_sample($formattedName);
}
createCompilationResult
Creates a new CompilationResult in a given project and location.
The async variant is DataformClient::createCompilationResultAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\CreateCompilationResultRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\CompilationResult |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\CompilationResult;
use Google\Cloud\Dataform\V1beta1\CreateCompilationResultRequest;
/**
* @param string $formattedParent The repository in which to create the compilation result. Must be
* in the format `projects/*/locations/*/repositories/*`. Please see
* {@see DataformClient::repositoryName()} for help formatting this field.
*/
function create_compilation_result_sample(string $formattedParent): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$compilationResult = new CompilationResult();
$request = (new CreateCompilationResultRequest())
->setParent($formattedParent)
->setCompilationResult($compilationResult);
// Call the API and handle any network failures.
try {
/** @var CompilationResult $response */
$response = $dataformClient->createCompilationResult($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DataformClient::repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]');
create_compilation_result_sample($formattedParent);
}
createFolder
Creates a new Folder in a given project and location.
The async variant is DataformClient::createFolderAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\CreateFolderRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\Folder |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\CreateFolderRequest;
use Google\Cloud\Dataform\V1beta1\Folder;
/**
* @param string $formattedParent The location in which to create the Folder. Must be in the format
* `projects/*/locations/*`. Please see
* {@see DataformClient::locationName()} for help formatting this field.
* @param string $folderDisplayName The Folder's user-friendly name.
*/
function create_folder_sample(string $formattedParent, string $folderDisplayName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$folder = (new Folder())
->setDisplayName($folderDisplayName);
$request = (new CreateFolderRequest())
->setParent($formattedParent)
->setFolder($folder);
// Call the API and handle any network failures.
try {
/** @var Folder $response */
$response = $dataformClient->createFolder($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DataformClient::locationName('[PROJECT]', '[LOCATION]');
$folderDisplayName = '[DISPLAY_NAME]';
create_folder_sample($formattedParent, $folderDisplayName);
}
createReleaseConfig
Creates a new ReleaseConfig in a given Repository.
The async variant is DataformClient::createReleaseConfigAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\CreateReleaseConfigRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\ReleaseConfig |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\CreateReleaseConfigRequest;
use Google\Cloud\Dataform\V1beta1\ReleaseConfig;
/**
* @param string $formattedParent The repository in which to create the release config. Must be in
* the format `projects/*/locations/*/repositories/*`. Please see
* {@see DataformClient::repositoryName()} for help formatting this field.
* @param string $releaseConfigGitCommitish Git commit/tag/branch name at which the repository should be
* compiled. Must exist in the remote repository. Examples:
* - a commit SHA: `12ade345`
* - a tag: `tag1`
* - a branch name: `branch1`
* @param string $releaseConfigId The ID to use for the release config, which will become the final
* component of the release config's resource name.
*/
function create_release_config_sample(
string $formattedParent,
string $releaseConfigGitCommitish,
string $releaseConfigId
): void {
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$releaseConfig = (new ReleaseConfig())
->setGitCommitish($releaseConfigGitCommitish);
$request = (new CreateReleaseConfigRequest())
->setParent($formattedParent)
->setReleaseConfig($releaseConfig)
->setReleaseConfigId($releaseConfigId);
// Call the API and handle any network failures.
try {
/** @var ReleaseConfig $response */
$response = $dataformClient->createReleaseConfig($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DataformClient::repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]');
$releaseConfigGitCommitish = '[GIT_COMMITISH]';
$releaseConfigId = '[RELEASE_CONFIG_ID]';
create_release_config_sample($formattedParent, $releaseConfigGitCommitish, $releaseConfigId);
}
createRepository
Creates a new Repository in a given project and location.
The async variant is DataformClient::createRepositoryAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\CreateRepositoryRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\Repository |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\CreateRepositoryRequest;
use Google\Cloud\Dataform\V1beta1\Repository;
/**
* @param string $formattedParent The location in which to create the repository. Must be in the
* format `projects/*/locations/*`. Please see
* {@see DataformClient::locationName()} for help formatting this field.
* @param string $repositoryId The ID to use for the repository, which will become the final
* component of the repository's resource name.
*/
function create_repository_sample(string $formattedParent, string $repositoryId): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$repository = new Repository();
$request = (new CreateRepositoryRequest())
->setParent($formattedParent)
->setRepository($repository)
->setRepositoryId($repositoryId);
// Call the API and handle any network failures.
try {
/** @var Repository $response */
$response = $dataformClient->createRepository($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DataformClient::locationName('[PROJECT]', '[LOCATION]');
$repositoryId = '[REPOSITORY_ID]';
create_repository_sample($formattedParent, $repositoryId);
}
createTeamFolder
Creates a new TeamFolder in a given project and location.
The async variant is DataformClient::createTeamFolderAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\CreateTeamFolderRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\TeamFolder |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\CreateTeamFolderRequest;
use Google\Cloud\Dataform\V1beta1\TeamFolder;
/**
* @param string $formattedParent The location in which to create the TeamFolder. Must be in the
* format `projects/*/locations/*`. Please see
* {@see DataformClient::locationName()} for help formatting this field.
* @param string $teamFolderDisplayName The TeamFolder's user-friendly name.
*/
function create_team_folder_sample(string $formattedParent, string $teamFolderDisplayName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$teamFolder = (new TeamFolder())
->setDisplayName($teamFolderDisplayName);
$request = (new CreateTeamFolderRequest())
->setParent($formattedParent)
->setTeamFolder($teamFolder);
// Call the API and handle any network failures.
try {
/** @var TeamFolder $response */
$response = $dataformClient->createTeamFolder($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DataformClient::locationName('[PROJECT]', '[LOCATION]');
$teamFolderDisplayName = '[DISPLAY_NAME]';
create_team_folder_sample($formattedParent, $teamFolderDisplayName);
}
createWorkflowConfig
Creates a new WorkflowConfig in a given Repository.
The async variant is DataformClient::createWorkflowConfigAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\CreateWorkflowConfigRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\WorkflowConfig |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\CreateWorkflowConfigRequest;
use Google\Cloud\Dataform\V1beta1\WorkflowConfig;
/**
* @param string $formattedParent The repository in which to create the workflow config. Must be in
* the format `projects/*/locations/*/repositories/*`. Please see
* {@see DataformClient::repositoryName()} for help formatting this field.
* @param string $formattedWorkflowConfigReleaseConfig The name of the release config whose release_compilation_result
* should be executed. Must be in the format
* `projects/*/locations/*/repositories/*/releaseConfigs/*`. Please see
* {@see DataformClient::releaseConfigName()} for help formatting this field.
* @param string $workflowConfigId The ID to use for the workflow config, which will become the
* final component of the workflow config's resource name.
*/
function create_workflow_config_sample(
string $formattedParent,
string $formattedWorkflowConfigReleaseConfig,
string $workflowConfigId
): void {
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$workflowConfig = (new WorkflowConfig())
->setReleaseConfig($formattedWorkflowConfigReleaseConfig);
$request = (new CreateWorkflowConfigRequest())
->setParent($formattedParent)
->setWorkflowConfig($workflowConfig)
->setWorkflowConfigId($workflowConfigId);
// Call the API and handle any network failures.
try {
/** @var WorkflowConfig $response */
$response = $dataformClient->createWorkflowConfig($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DataformClient::repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]');
$formattedWorkflowConfigReleaseConfig = DataformClient::releaseConfigName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[RELEASE_CONFIG]'
);
$workflowConfigId = '[WORKFLOW_CONFIG_ID]';
create_workflow_config_sample(
$formattedParent,
$formattedWorkflowConfigReleaseConfig,
$workflowConfigId
);
}
createWorkflowInvocation
Creates a new WorkflowInvocation in a given Repository.
The async variant is DataformClient::createWorkflowInvocationAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\CreateWorkflowInvocationRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\WorkflowInvocation |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\CreateWorkflowInvocationRequest;
use Google\Cloud\Dataform\V1beta1\WorkflowInvocation;
/**
* @param string $formattedParent The repository in which to create the workflow invocation. Must
* be in the format `projects/*/locations/*/repositories/*`. Please see
* {@see DataformClient::repositoryName()} for help formatting this field.
*/
function create_workflow_invocation_sample(string $formattedParent): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$workflowInvocation = new WorkflowInvocation();
$request = (new CreateWorkflowInvocationRequest())
->setParent($formattedParent)
->setWorkflowInvocation($workflowInvocation);
// Call the API and handle any network failures.
try {
/** @var WorkflowInvocation $response */
$response = $dataformClient->createWorkflowInvocation($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DataformClient::repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]');
create_workflow_invocation_sample($formattedParent);
}
createWorkspace
Creates a new Workspace in a given Repository.
The async variant is DataformClient::createWorkspaceAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\CreateWorkspaceRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\Workspace |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\CreateWorkspaceRequest;
use Google\Cloud\Dataform\V1beta1\Workspace;
/**
* @param string $formattedParent The repository in which to create the workspace. Must be in the
* format `projects/*/locations/*/repositories/*`. Please see
* {@see DataformClient::repositoryName()} for help formatting this field.
* @param string $workspaceId The ID to use for the workspace, which will become the final
* component of the workspace's resource name.
*/
function create_workspace_sample(string $formattedParent, string $workspaceId): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$workspace = new Workspace();
$request = (new CreateWorkspaceRequest())
->setParent($formattedParent)
->setWorkspace($workspace)
->setWorkspaceId($workspaceId);
// Call the API and handle any network failures.
try {
/** @var Workspace $response */
$response = $dataformClient->createWorkspace($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DataformClient::repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]');
$workspaceId = '[WORKSPACE_ID]';
create_workspace_sample($formattedParent, $workspaceId);
}
deleteFolder
Deletes a single Folder.
The async variant is DataformClient::deleteFolderAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\DeleteFolderRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\DeleteFolderRequest;
/**
* @param string $formattedName The Folder's name. Please see
* {@see DataformClient::folderName()} for help formatting this field.
*/
function delete_folder_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new DeleteFolderRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$dataformClient->deleteFolder($request);
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::folderName('[PROJECT]', '[LOCATION]', '[FOLDER]');
delete_folder_sample($formattedName);
}
deleteReleaseConfig
Deletes a single ReleaseConfig.
The async variant is DataformClient::deleteReleaseConfigAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\DeleteReleaseConfigRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\DeleteReleaseConfigRequest;
/**
* @param string $formattedName The release config's name. Please see
* {@see DataformClient::releaseConfigName()} for help formatting this field.
*/
function delete_release_config_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new DeleteReleaseConfigRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$dataformClient->deleteReleaseConfig($request);
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::releaseConfigName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[RELEASE_CONFIG]'
);
delete_release_config_sample($formattedName);
}
deleteRepository
Deletes a single Repository.
The async variant is DataformClient::deleteRepositoryAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\DeleteRepositoryRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\DeleteRepositoryRequest;
/**
* @param string $formattedName The repository's name. Please see
* {@see DataformClient::repositoryName()} for help formatting this field.
*/
function delete_repository_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new DeleteRepositoryRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$dataformClient->deleteRepository($request);
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]');
delete_repository_sample($formattedName);
}
deleteTeamFolder
Deletes a single TeamFolder.
The async variant is DataformClient::deleteTeamFolderAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\DeleteTeamFolderRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\DeleteTeamFolderRequest;
/**
* @param string $formattedName The TeamFolder's name. Please see
* {@see DataformClient::teamFolderName()} for help formatting this field.
*/
function delete_team_folder_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new DeleteTeamFolderRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$dataformClient->deleteTeamFolder($request);
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::teamFolderName('[PROJECT]', '[LOCATION]', '[TEAM_FOLDER]');
delete_team_folder_sample($formattedName);
}
deleteWorkflowConfig
Deletes a single WorkflowConfig.
The async variant is DataformClient::deleteWorkflowConfigAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\DeleteWorkflowConfigRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\DeleteWorkflowConfigRequest;
/**
* @param string $formattedName The workflow config's name. Please see
* {@see DataformClient::workflowConfigName()} for help formatting this field.
*/
function delete_workflow_config_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new DeleteWorkflowConfigRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$dataformClient->deleteWorkflowConfig($request);
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::workflowConfigName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[WORKFLOW_CONFIG]'
);
delete_workflow_config_sample($formattedName);
}
deleteWorkflowInvocation
Deletes a single WorkflowInvocation.
The async variant is DataformClient::deleteWorkflowInvocationAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\DeleteWorkflowInvocationRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\DeleteWorkflowInvocationRequest;
/**
* @param string $formattedName The workflow invocation resource's name. Please see
* {@see DataformClient::workflowInvocationName()} for help formatting this field.
*/
function delete_workflow_invocation_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new DeleteWorkflowInvocationRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$dataformClient->deleteWorkflowInvocation($request);
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::workflowInvocationName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[WORKFLOW_INVOCATION]'
);
delete_workflow_invocation_sample($formattedName);
}
deleteWorkspace
Deletes a single Workspace.
The async variant is DataformClient::deleteWorkspaceAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\DeleteWorkspaceRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\DeleteWorkspaceRequest;
/**
* @param string $formattedName The workspace resource's name. Please see
* {@see DataformClient::workspaceName()} for help formatting this field.
*/
function delete_workspace_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new DeleteWorkspaceRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$dataformClient->deleteWorkspace($request);
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::workspaceName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[WORKSPACE]'
);
delete_workspace_sample($formattedName);
}
fetchFileDiff
Fetches Git diff for an uncommitted file in a Workspace.
The async variant is DataformClient::fetchFileDiffAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\FetchFileDiffRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\FetchFileDiffResponse |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\FetchFileDiffRequest;
use Google\Cloud\Dataform\V1beta1\FetchFileDiffResponse;
/**
* @param string $formattedWorkspace The workspace's name. Please see
* {@see DataformClient::workspaceName()} for help formatting this field.
* @param string $path The file's full path including filename, relative to the
* workspace root.
*/
function fetch_file_diff_sample(string $formattedWorkspace, string $path): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new FetchFileDiffRequest())
->setWorkspace($formattedWorkspace)
->setPath($path);
// Call the API and handle any network failures.
try {
/** @var FetchFileDiffResponse $response */
$response = $dataformClient->fetchFileDiff($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedWorkspace = DataformClient::workspaceName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[WORKSPACE]'
);
$path = '[PATH]';
fetch_file_diff_sample($formattedWorkspace, $path);
}
fetchFileGitStatuses
Fetches Git statuses for the files in a Workspace.
The async variant is DataformClient::fetchFileGitStatusesAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\FetchFileGitStatusesRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\FetchFileGitStatusesResponse |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\FetchFileGitStatusesRequest;
use Google\Cloud\Dataform\V1beta1\FetchFileGitStatusesResponse;
/**
* @param string $formattedName The workspace's name. Please see
* {@see DataformClient::workspaceName()} for help formatting this field.
*/
function fetch_file_git_statuses_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new FetchFileGitStatusesRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var FetchFileGitStatusesResponse $response */
$response = $dataformClient->fetchFileGitStatuses($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::workspaceName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[WORKSPACE]'
);
fetch_file_git_statuses_sample($formattedName);
}
fetchGitAheadBehind
Fetches Git ahead/behind against a remote branch.
The async variant is DataformClient::fetchGitAheadBehindAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\FetchGitAheadBehindRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\FetchGitAheadBehindResponse |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\FetchGitAheadBehindRequest;
use Google\Cloud\Dataform\V1beta1\FetchGitAheadBehindResponse;
/**
* @param string $formattedName The workspace's name. Please see
* {@see DataformClient::workspaceName()} for help formatting this field.
*/
function fetch_git_ahead_behind_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new FetchGitAheadBehindRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var FetchGitAheadBehindResponse $response */
$response = $dataformClient->fetchGitAheadBehind($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::workspaceName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[WORKSPACE]'
);
fetch_git_ahead_behind_sample($formattedName);
}
fetchRemoteBranches
Fetches a Repository's remote branches.
The async variant is DataformClient::fetchRemoteBranchesAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\FetchRemoteBranchesRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\FetchRemoteBranchesResponse |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\FetchRemoteBranchesRequest;
use Google\Cloud\Dataform\V1beta1\FetchRemoteBranchesResponse;
/**
* @param string $formattedName The repository's name. Please see
* {@see DataformClient::repositoryName()} for help formatting this field.
*/
function fetch_remote_branches_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new FetchRemoteBranchesRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var FetchRemoteBranchesResponse $response */
$response = $dataformClient->fetchRemoteBranches($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]');
fetch_remote_branches_sample($formattedName);
}
fetchRepositoryHistory
Fetches a Repository's history of commits. The Repository must not have a
value for git_remote_settings.url.
The async variant is DataformClient::fetchRepositoryHistoryAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\FetchRepositoryHistoryRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\CommitLogEntry;
use Google\Cloud\Dataform\V1beta1\FetchRepositoryHistoryRequest;
/**
* @param string $formattedName The repository's name. Please see
* {@see DataformClient::repositoryName()} for help formatting this field.
*/
function fetch_repository_history_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new FetchRepositoryHistoryRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataformClient->fetchRepositoryHistory($request);
/** @var CommitLogEntry $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]');
fetch_repository_history_sample($formattedName);
}
getCompilationResult
Fetches a single CompilationResult.
The async variant is DataformClient::getCompilationResultAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\GetCompilationResultRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\CompilationResult |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\CompilationResult;
use Google\Cloud\Dataform\V1beta1\GetCompilationResultRequest;
/**
* @param string $formattedName The compilation result's name. Please see
* {@see DataformClient::compilationResultName()} for help formatting this field.
*/
function get_compilation_result_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new GetCompilationResultRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var CompilationResult $response */
$response = $dataformClient->getCompilationResult($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::compilationResultName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[COMPILATION_RESULT]'
);
get_compilation_result_sample($formattedName);
}
getConfig
Get default config for a given project and location.
The async variant is DataformClient::getConfigAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\GetConfigRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\Config |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\Config;
use Google\Cloud\Dataform\V1beta1\GetConfigRequest;
/**
* @param string $formattedName The config name. Please see
* {@see DataformClient::configName()} for help formatting this field.
*/
function get_config_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new GetConfigRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Config $response */
$response = $dataformClient->getConfig($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::configName('[PROJECT]', '[LOCATION]');
get_config_sample($formattedName);
}
getFolder
Fetches a single Folder.
The async variant is DataformClient::getFolderAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\GetFolderRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\Folder |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\Folder;
use Google\Cloud\Dataform\V1beta1\GetFolderRequest;
/**
* @param string $formattedName The Folder's name. Please see
* {@see DataformClient::folderName()} for help formatting this field.
*/
function get_folder_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new GetFolderRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Folder $response */
$response = $dataformClient->getFolder($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::folderName('[PROJECT]', '[LOCATION]', '[FOLDER]');
get_folder_sample($formattedName);
}
getIamPolicy
Gets the access control policy for a resource.
Returns an empty policy if the resource exists and does not have a policy set.
The async variant is DataformClient::getIamPolicyAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Iam\V1\GetIamPolicyRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Iam\V1\Policy |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;
/**
* @param string $resource REQUIRED: The resource for which the policy is being requested.
* See the operation documentation for the appropriate value for this field.
*/
function get_iam_policy_sample(string $resource): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new GetIamPolicyRequest())
->setResource($resource);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $dataformClient->getIamPolicy($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
get_iam_policy_sample($resource);
}
getReleaseConfig
Fetches a single ReleaseConfig.
The async variant is DataformClient::getReleaseConfigAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\GetReleaseConfigRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\ReleaseConfig |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\GetReleaseConfigRequest;
use Google\Cloud\Dataform\V1beta1\ReleaseConfig;
/**
* @param string $formattedName The release config's name. Please see
* {@see DataformClient::releaseConfigName()} for help formatting this field.
*/
function get_release_config_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new GetReleaseConfigRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var ReleaseConfig $response */
$response = $dataformClient->getReleaseConfig($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::releaseConfigName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[RELEASE_CONFIG]'
);
get_release_config_sample($formattedName);
}
getRepository
Fetches a single Repository.
The async variant is DataformClient::getRepositoryAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\GetRepositoryRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\Repository |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\GetRepositoryRequest;
use Google\Cloud\Dataform\V1beta1\Repository;
/**
* @param string $formattedName The repository's name. Please see
* {@see DataformClient::repositoryName()} for help formatting this field.
*/
function get_repository_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new GetRepositoryRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Repository $response */
$response = $dataformClient->getRepository($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]');
get_repository_sample($formattedName);
}
getTeamFolder
Fetches a single TeamFolder.
The async variant is DataformClient::getTeamFolderAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\GetTeamFolderRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\TeamFolder |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\GetTeamFolderRequest;
use Google\Cloud\Dataform\V1beta1\TeamFolder;
/**
* @param string $formattedName The TeamFolder's name. Please see
* {@see DataformClient::teamFolderName()} for help formatting this field.
*/
function get_team_folder_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new GetTeamFolderRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var TeamFolder $response */
$response = $dataformClient->getTeamFolder($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::teamFolderName('[PROJECT]', '[LOCATION]', '[TEAM_FOLDER]');
get_team_folder_sample($formattedName);
}
getWorkflowConfig
Fetches a single WorkflowConfig.
The async variant is DataformClient::getWorkflowConfigAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\GetWorkflowConfigRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\WorkflowConfig |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\GetWorkflowConfigRequest;
use Google\Cloud\Dataform\V1beta1\WorkflowConfig;
/**
* @param string $formattedName The workflow config's name. Please see
* {@see DataformClient::workflowConfigName()} for help formatting this field.
*/
function get_workflow_config_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new GetWorkflowConfigRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var WorkflowConfig $response */
$response = $dataformClient->getWorkflowConfig($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::workflowConfigName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[WORKFLOW_CONFIG]'
);
get_workflow_config_sample($formattedName);
}
getWorkflowInvocation
Fetches a single WorkflowInvocation.
The async variant is DataformClient::getWorkflowInvocationAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\GetWorkflowInvocationRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\WorkflowInvocation |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\GetWorkflowInvocationRequest;
use Google\Cloud\Dataform\V1beta1\WorkflowInvocation;
/**
* @param string $formattedName The workflow invocation resource's name. Please see
* {@see DataformClient::workflowInvocationName()} for help formatting this field.
*/
function get_workflow_invocation_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new GetWorkflowInvocationRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var WorkflowInvocation $response */
$response = $dataformClient->getWorkflowInvocation($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::workflowInvocationName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[WORKFLOW_INVOCATION]'
);
get_workflow_invocation_sample($formattedName);
}
getWorkspace
Fetches a single Workspace.
The async variant is DataformClient::getWorkspaceAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\GetWorkspaceRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\Workspace |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\GetWorkspaceRequest;
use Google\Cloud\Dataform\V1beta1\Workspace;
/**
* @param string $formattedName The workspace's name. Please see
* {@see DataformClient::workspaceName()} for help formatting this field.
*/
function get_workspace_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new GetWorkspaceRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Workspace $response */
$response = $dataformClient->getWorkspace($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::workspaceName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[WORKSPACE]'
);
get_workspace_sample($formattedName);
}
installNpmPackages
Installs dependency NPM packages (inside a Workspace).
The async variant is DataformClient::installNpmPackagesAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\InstallNpmPackagesRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\InstallNpmPackagesResponse |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\InstallNpmPackagesRequest;
use Google\Cloud\Dataform\V1beta1\InstallNpmPackagesResponse;
/**
* @param string $formattedWorkspace The workspace's name. Please see
* {@see DataformClient::workspaceName()} for help formatting this field.
*/
function install_npm_packages_sample(string $formattedWorkspace): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new InstallNpmPackagesRequest())
->setWorkspace($formattedWorkspace);
// Call the API and handle any network failures.
try {
/** @var InstallNpmPackagesResponse $response */
$response = $dataformClient->installNpmPackages($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedWorkspace = DataformClient::workspaceName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[WORKSPACE]'
);
install_npm_packages_sample($formattedWorkspace);
}
listCompilationResults
Lists CompilationResults in a given Repository.
The async variant is DataformClient::listCompilationResultsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\ListCompilationResultsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\CompilationResult;
use Google\Cloud\Dataform\V1beta1\ListCompilationResultsRequest;
/**
* @param string $formattedParent The repository in which to list compilation results. Must be in
* the format `projects/*/locations/*/repositories/*`. Please see
* {@see DataformClient::repositoryName()} for help formatting this field.
*/
function list_compilation_results_sample(string $formattedParent): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new ListCompilationResultsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataformClient->listCompilationResults($request);
/** @var CompilationResult $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DataformClient::repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]');
list_compilation_results_sample($formattedParent);
}
listReleaseConfigs
Lists ReleaseConfigs in a given Repository.
The async variant is DataformClient::listReleaseConfigsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\ListReleaseConfigsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\ListReleaseConfigsRequest;
use Google\Cloud\Dataform\V1beta1\ReleaseConfig;
/**
* @param string $formattedParent The repository in which to list release configs. Must be in the
* format `projects/*/locations/*/repositories/*`. Please see
* {@see DataformClient::repositoryName()} for help formatting this field.
*/
function list_release_configs_sample(string $formattedParent): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new ListReleaseConfigsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataformClient->listReleaseConfigs($request);
/** @var ReleaseConfig $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DataformClient::repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]');
list_release_configs_sample($formattedParent);
}
listRepositories
Lists Repositories in a given project and location.
Note: This method can return repositories not shown in the Dataform UI.
The async variant is DataformClient::listRepositoriesAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\ListRepositoriesRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\ListRepositoriesRequest;
use Google\Cloud\Dataform\V1beta1\Repository;
/**
* @param string $formattedParent The location in which to list repositories. Must be in the format
* `projects/*/locations/*`. Please see
* {@see DataformClient::locationName()} for help formatting this field.
*/
function list_repositories_sample(string $formattedParent): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new ListRepositoriesRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataformClient->listRepositories($request);
/** @var Repository $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DataformClient::locationName('[PROJECT]', '[LOCATION]');
list_repositories_sample($formattedParent);
}
listWorkflowConfigs
Lists WorkflowConfigs in a given Repository.
The async variant is DataformClient::listWorkflowConfigsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\ListWorkflowConfigsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\ListWorkflowConfigsRequest;
use Google\Cloud\Dataform\V1beta1\WorkflowConfig;
/**
* @param string $formattedParent The repository in which to list workflow configs. Must be in the
* format `projects/*/locations/*/repositories/*`. Please see
* {@see DataformClient::repositoryName()} for help formatting this field.
*/
function list_workflow_configs_sample(string $formattedParent): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new ListWorkflowConfigsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataformClient->listWorkflowConfigs($request);
/** @var WorkflowConfig $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DataformClient::repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]');
list_workflow_configs_sample($formattedParent);
}
listWorkflowInvocations
Lists WorkflowInvocations in a given Repository.
The async variant is DataformClient::listWorkflowInvocationsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\ListWorkflowInvocationsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\ListWorkflowInvocationsRequest;
use Google\Cloud\Dataform\V1beta1\WorkflowInvocation;
/**
* @param string $formattedParent The parent resource of the WorkflowInvocation type. Must be in
* the format `projects/*/locations/*/repositories/*`. Please see
* {@see DataformClient::repositoryName()} for help formatting this field.
*/
function list_workflow_invocations_sample(string $formattedParent): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new ListWorkflowInvocationsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataformClient->listWorkflowInvocations($request);
/** @var WorkflowInvocation $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DataformClient::repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]');
list_workflow_invocations_sample($formattedParent);
}
listWorkspaces
Lists Workspaces in a given Repository.
The async variant is DataformClient::listWorkspacesAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\ListWorkspacesRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\ListWorkspacesRequest;
use Google\Cloud\Dataform\V1beta1\Workspace;
/**
* @param string $formattedParent The repository in which to list workspaces. Must be in the
* format `projects/*/locations/*/repositories/*`. Please see
* {@see DataformClient::repositoryName()} for help formatting this field.
*/
function list_workspaces_sample(string $formattedParent): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new ListWorkspacesRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataformClient->listWorkspaces($request);
/** @var Workspace $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DataformClient::repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]');
list_workspaces_sample($formattedParent);
}
makeDirectory
Creates a directory inside a Workspace.
The async variant is DataformClient::makeDirectoryAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\MakeDirectoryRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\MakeDirectoryResponse |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\MakeDirectoryRequest;
use Google\Cloud\Dataform\V1beta1\MakeDirectoryResponse;
/**
* @param string $formattedWorkspace The workspace's name. Please see
* {@see DataformClient::workspaceName()} for help formatting this field.
* @param string $path The directory's full path including directory name, relative to
* the workspace root.
*/
function make_directory_sample(string $formattedWorkspace, string $path): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new MakeDirectoryRequest())
->setWorkspace($formattedWorkspace)
->setPath($path);
// Call the API and handle any network failures.
try {
/** @var MakeDirectoryResponse $response */
$response = $dataformClient->makeDirectory($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedWorkspace = DataformClient::workspaceName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[WORKSPACE]'
);
$path = '[PATH]';
make_directory_sample($formattedWorkspace, $path);
}
moveDirectory
Moves a directory (inside a Workspace), and all of its contents, to a new location.
The async variant is DataformClient::moveDirectoryAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\MoveDirectoryRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\MoveDirectoryResponse |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\MoveDirectoryRequest;
use Google\Cloud\Dataform\V1beta1\MoveDirectoryResponse;
/**
* @param string $formattedWorkspace The workspace's name. Please see
* {@see DataformClient::workspaceName()} for help formatting this field.
* @param string $path The directory's full path including directory name, relative to
* the workspace root.
* @param string $newPath The new path for the directory including directory name, rooted
* at workspace root.
*/
function move_directory_sample(string $formattedWorkspace, string $path, string $newPath): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new MoveDirectoryRequest())
->setWorkspace($formattedWorkspace)
->setPath($path)
->setNewPath($newPath);
// Call the API and handle any network failures.
try {
/** @var MoveDirectoryResponse $response */
$response = $dataformClient->moveDirectory($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedWorkspace = DataformClient::workspaceName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[WORKSPACE]'
);
$path = '[PATH]';
$newPath = '[NEW_PATH]';
move_directory_sample($formattedWorkspace, $path, $newPath);
}
moveFile
Moves a file (inside a Workspace) to a new location.
The async variant is DataformClient::moveFileAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\MoveFileRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\MoveFileResponse |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\MoveFileRequest;
use Google\Cloud\Dataform\V1beta1\MoveFileResponse;
/**
* @param string $formattedWorkspace The workspace's name. Please see
* {@see DataformClient::workspaceName()} for help formatting this field.
* @param string $path The file's full path including filename, relative to the
* workspace root.
* @param string $newPath The file's new path including filename, relative to the workspace
* root.
*/
function move_file_sample(string $formattedWorkspace, string $path, string $newPath): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new MoveFileRequest())
->setWorkspace($formattedWorkspace)
->setPath($path)
->setNewPath($newPath);
// Call the API and handle any network failures.
try {
/** @var MoveFileResponse $response */
$response = $dataformClient->moveFile($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedWorkspace = DataformClient::workspaceName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[WORKSPACE]'
);
$path = '[PATH]';
$newPath = '[NEW_PATH]';
move_file_sample($formattedWorkspace, $path, $newPath);
}
moveFolder
Moves a Folder to a new Folder, TeamFolder, or the root location.
The async variant is DataformClient::moveFolderAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\MoveFolderRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse<null> |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\MoveFolderRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The full resource name of the Folder to move. Please see
* {@see DataformClient::folderName()} for help formatting this field.
*/
function move_folder_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new MoveFolderRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataformClient->moveFolder($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::folderName('[PROJECT]', '[LOCATION]', '[FOLDER]');
move_folder_sample($formattedName);
}
moveRepository
Moves a Repository to a new location.
The async variant is DataformClient::moveRepositoryAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\MoveRepositoryRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse<null> |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\MoveRepositoryRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The full resource name of the repository to move. Please see
* {@see DataformClient::repositoryName()} for help formatting this field.
*/
function move_repository_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new MoveRepositoryRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataformClient->moveRepository($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]');
move_repository_sample($formattedName);
}
pullGitCommits
Pulls Git commits from the Repository's remote into a Workspace.
The async variant is DataformClient::pullGitCommitsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\PullGitCommitsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\PullGitCommitsResponse |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\CommitAuthor;
use Google\Cloud\Dataform\V1beta1\PullGitCommitsRequest;
use Google\Cloud\Dataform\V1beta1\PullGitCommitsResponse;
/**
* @param string $formattedName The workspace's name. Please see
* {@see DataformClient::workspaceName()} for help formatting this field.
* @param string $authorName The commit author's name.
* @param string $authorEmailAddress The commit author's email address.
*/
function pull_git_commits_sample(
string $formattedName,
string $authorName,
string $authorEmailAddress
): void {
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$author = (new CommitAuthor())
->setName($authorName)
->setEmailAddress($authorEmailAddress);
$request = (new PullGitCommitsRequest())
->setName($formattedName)
->setAuthor($author);
// Call the API and handle any network failures.
try {
/** @var PullGitCommitsResponse $response */
$response = $dataformClient->pullGitCommits($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::workspaceName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[WORKSPACE]'
);
$authorName = '[NAME]';
$authorEmailAddress = '[EMAIL_ADDRESS]';
pull_git_commits_sample($formattedName, $authorName, $authorEmailAddress);
}
pushGitCommits
Pushes Git commits from a Workspace to the Repository's remote.
The async variant is DataformClient::pushGitCommitsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\PushGitCommitsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\PushGitCommitsResponse |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\PushGitCommitsRequest;
use Google\Cloud\Dataform\V1beta1\PushGitCommitsResponse;
/**
* @param string $formattedName The workspace's name. Please see
* {@see DataformClient::workspaceName()} for help formatting this field.
*/
function push_git_commits_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new PushGitCommitsRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var PushGitCommitsResponse $response */
$response = $dataformClient->pushGitCommits($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::workspaceName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[WORKSPACE]'
);
push_git_commits_sample($formattedName);
}
queryCompilationResultActions
Returns CompilationResultActions in a given CompilationResult.
The async variant is DataformClient::queryCompilationResultActionsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\QueryCompilationResultActionsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\CompilationResultAction;
use Google\Cloud\Dataform\V1beta1\QueryCompilationResultActionsRequest;
/**
* @param string $formattedName The compilation result's name. Please see
* {@see DataformClient::compilationResultName()} for help formatting this field.
*/
function query_compilation_result_actions_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new QueryCompilationResultActionsRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataformClient->queryCompilationResultActions($request);
/** @var CompilationResultAction $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::compilationResultName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[COMPILATION_RESULT]'
);
query_compilation_result_actions_sample($formattedName);
}
queryDirectoryContents
Returns the contents of a given Workspace directory.
The async variant is DataformClient::queryDirectoryContentsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\QueryDirectoryContentsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\DirectoryEntry;
use Google\Cloud\Dataform\V1beta1\QueryDirectoryContentsRequest;
/**
* @param string $formattedWorkspace The workspace's name. Please see
* {@see DataformClient::workspaceName()} for help formatting this field.
*/
function query_directory_contents_sample(string $formattedWorkspace): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new QueryDirectoryContentsRequest())
->setWorkspace($formattedWorkspace);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataformClient->queryDirectoryContents($request);
/** @var DirectoryEntry $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedWorkspace = DataformClient::workspaceName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[WORKSPACE]'
);
query_directory_contents_sample($formattedWorkspace);
}
queryFolderContents
Returns the contents of a given Folder.
The async variant is DataformClient::queryFolderContentsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\QueryFolderContentsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\QueryFolderContentsRequest;
use Google\Cloud\Dataform\V1beta1\QueryFolderContentsResponse\FolderContentsEntry;
/**
* @param string $formattedFolder Name of the folder whose contents to list.
* Format: projects/*/locations/*/folders/*
* Please see {@see DataformClient::folderName()} for help formatting this field.
*/
function query_folder_contents_sample(string $formattedFolder): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new QueryFolderContentsRequest())
->setFolder($formattedFolder);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataformClient->queryFolderContents($request);
/** @var FolderContentsEntry $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedFolder = DataformClient::folderName('[PROJECT]', '[LOCATION]', '[FOLDER]');
query_folder_contents_sample($formattedFolder);
}
queryRepositoryDirectoryContents
Returns the contents of a given Repository directory. The Repository must
not have a value for git_remote_settings.url.
The async variant is DataformClient::queryRepositoryDirectoryContentsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\QueryRepositoryDirectoryContentsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\DirectoryEntry;
use Google\Cloud\Dataform\V1beta1\QueryRepositoryDirectoryContentsRequest;
/**
* @param string $formattedName The repository's name. Please see
* {@see DataformClient::repositoryName()} for help formatting this field.
*/
function query_repository_directory_contents_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new QueryRepositoryDirectoryContentsRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataformClient->queryRepositoryDirectoryContents($request);
/** @var DirectoryEntry $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]');
query_repository_directory_contents_sample($formattedName);
}
queryTeamFolderContents
Returns the contents of a given TeamFolder.
The async variant is DataformClient::queryTeamFolderContentsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\QueryTeamFolderContentsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\QueryTeamFolderContentsRequest;
use Google\Cloud\Dataform\V1beta1\QueryTeamFolderContentsResponse\TeamFolderContentsEntry;
/**
* @param string $formattedTeamFolder Name of the team_folder whose contents to list.
* Format: `projects/*/locations/*/teamFolders/*`. Please see
* {@see DataformClient::teamFolderName()} for help formatting this field.
*/
function query_team_folder_contents_sample(string $formattedTeamFolder): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new QueryTeamFolderContentsRequest())
->setTeamFolder($formattedTeamFolder);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataformClient->queryTeamFolderContents($request);
/** @var TeamFolderContentsEntry $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedTeamFolder = DataformClient::teamFolderName('[PROJECT]', '[LOCATION]', '[TEAM_FOLDER]');
query_team_folder_contents_sample($formattedTeamFolder);
}
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.
The async variant is DataformClient::queryUserRootContentsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\QueryUserRootContentsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\QueryUserRootContentsRequest;
use Google\Cloud\Dataform\V1beta1\QueryUserRootContentsResponse\RootContentsEntry;
/**
* @param string $formattedLocation Location of the user root folder whose contents to list.
* Format: projects/*/locations/*
* Please see {@see DataformClient::locationName()} for help formatting this field.
*/
function query_user_root_contents_sample(string $formattedLocation): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new QueryUserRootContentsRequest())
->setLocation($formattedLocation);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataformClient->queryUserRootContents($request);
/** @var RootContentsEntry $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedLocation = DataformClient::locationName('[PROJECT]', '[LOCATION]');
query_user_root_contents_sample($formattedLocation);
}
queryWorkflowInvocationActions
Returns WorkflowInvocationActions in a given WorkflowInvocation.
The async variant is DataformClient::queryWorkflowInvocationActionsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\QueryWorkflowInvocationActionsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\QueryWorkflowInvocationActionsRequest;
use Google\Cloud\Dataform\V1beta1\WorkflowInvocationAction;
/**
* @param string $formattedName The workflow invocation's name. Please see
* {@see DataformClient::workflowInvocationName()} for help formatting this field.
*/
function query_workflow_invocation_actions_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new QueryWorkflowInvocationActionsRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataformClient->queryWorkflowInvocationActions($request);
/** @var WorkflowInvocationAction $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::workflowInvocationName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[WORKFLOW_INVOCATION]'
);
query_workflow_invocation_actions_sample($formattedName);
}
readFile
Returns the contents of a file (inside a Workspace).
The async variant is DataformClient::readFileAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\ReadFileRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\ReadFileResponse |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\ReadFileRequest;
use Google\Cloud\Dataform\V1beta1\ReadFileResponse;
/**
* @param string $formattedWorkspace The workspace's name. Please see
* {@see DataformClient::workspaceName()} for help formatting this field.
* @param string $path The file's full path including filename, relative to the
* workspace root.
*/
function read_file_sample(string $formattedWorkspace, string $path): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new ReadFileRequest())
->setWorkspace($formattedWorkspace)
->setPath($path);
// Call the API and handle any network failures.
try {
/** @var ReadFileResponse $response */
$response = $dataformClient->readFile($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedWorkspace = DataformClient::workspaceName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[WORKSPACE]'
);
$path = '[PATH]';
read_file_sample($formattedWorkspace, $path);
}
readRepositoryFile
Returns the contents of a file (inside a Repository). The Repository
must not have a value for git_remote_settings.url.
The async variant is DataformClient::readRepositoryFileAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\ReadRepositoryFileRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\ReadRepositoryFileResponse |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\ReadRepositoryFileRequest;
use Google\Cloud\Dataform\V1beta1\ReadRepositoryFileResponse;
/**
* @param string $formattedName The repository's name. Please see
* {@see DataformClient::repositoryName()} for help formatting this field.
* @param string $path Full file path to read including filename, from repository root.
*/
function read_repository_file_sample(string $formattedName, string $path): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new ReadRepositoryFileRequest())
->setName($formattedName)
->setPath($path);
// Call the API and handle any network failures.
try {
/** @var ReadRepositoryFileResponse $response */
$response = $dataformClient->readRepositoryFile($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::repositoryName('[PROJECT]', '[LOCATION]', '[REPOSITORY]');
$path = '[PATH]';
read_repository_file_sample($formattedName, $path);
}
removeDirectory
Deletes a directory (inside a Workspace) and all of its contents.
The async variant is DataformClient::removeDirectoryAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\RemoveDirectoryRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\RemoveDirectoryResponse |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\RemoveDirectoryRequest;
use Google\Cloud\Dataform\V1beta1\RemoveDirectoryResponse;
/**
* @param string $formattedWorkspace The workspace's name. Please see
* {@see DataformClient::workspaceName()} for help formatting this field.
* @param string $path The directory's full path including directory name, relative to
* the workspace root.
*/
function remove_directory_sample(string $formattedWorkspace, string $path): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new RemoveDirectoryRequest())
->setWorkspace($formattedWorkspace)
->setPath($path);
// Call the API and handle any network failures.
try {
/** @var RemoveDirectoryResponse $response */
$response = $dataformClient->removeDirectory($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedWorkspace = DataformClient::workspaceName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[WORKSPACE]'
);
$path = '[PATH]';
remove_directory_sample($formattedWorkspace, $path);
}
removeFile
Deletes a file (inside a Workspace).
The async variant is DataformClient::removeFileAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\RemoveFileRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\RemoveFileResponse |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\RemoveFileRequest;
use Google\Cloud\Dataform\V1beta1\RemoveFileResponse;
/**
* @param string $formattedWorkspace The workspace's name. Please see
* {@see DataformClient::workspaceName()} for help formatting this field.
* @param string $path The file's full path including filename, relative to the
* workspace root.
*/
function remove_file_sample(string $formattedWorkspace, string $path): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new RemoveFileRequest())
->setWorkspace($formattedWorkspace)
->setPath($path);
// Call the API and handle any network failures.
try {
/** @var RemoveFileResponse $response */
$response = $dataformClient->removeFile($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedWorkspace = DataformClient::workspaceName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[WORKSPACE]'
);
$path = '[PATH]';
remove_file_sample($formattedWorkspace, $path);
}
resetWorkspaceChanges
Performs a Git reset for uncommitted files in a Workspace.
The async variant is DataformClient::resetWorkspaceChangesAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\ResetWorkspaceChangesRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\ResetWorkspaceChangesResponse |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\ResetWorkspaceChangesRequest;
use Google\Cloud\Dataform\V1beta1\ResetWorkspaceChangesResponse;
/**
* @param string $formattedName The workspace's name. Please see
* {@see DataformClient::workspaceName()} for help formatting this field.
*/
function reset_workspace_changes_sample(string $formattedName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new ResetWorkspaceChangesRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var ResetWorkspaceChangesResponse $response */
$response = $dataformClient->resetWorkspaceChanges($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataformClient::workspaceName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[WORKSPACE]'
);
reset_workspace_changes_sample($formattedName);
}
searchFiles
Finds the contents of a given Workspace directory by filter.
The async variant is DataformClient::searchFilesAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\SearchFilesRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\SearchFilesRequest;
use Google\Cloud\Dataform\V1beta1\SearchResult;
/**
* @param string $formattedWorkspace The workspace's name. Please see
* {@see DataformClient::workspaceName()} for help formatting this field.
*/
function search_files_sample(string $formattedWorkspace): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new SearchFilesRequest())
->setWorkspace($formattedWorkspace);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataformClient->searchFiles($request);
/** @var SearchResult $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedWorkspace = DataformClient::workspaceName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[WORKSPACE]'
);
search_files_sample($formattedWorkspace);
}
searchTeamFolders
Returns all TeamFolders in a given location that the caller has access to and match the provided filter.
The async variant is DataformClient::searchTeamFoldersAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\SearchTeamFoldersRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\SearchTeamFoldersRequest;
use Google\Cloud\Dataform\V1beta1\SearchTeamFoldersResponse\TeamFolderSearchResult;
/**
* @param string $formattedLocation Location in which to query TeamFolders.
* Format: `projects/*/locations/*`. Please see
* {@see DataformClient::locationName()} for help formatting this field.
*/
function search_team_folders_sample(string $formattedLocation): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new SearchTeamFoldersRequest())
->setLocation($formattedLocation);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataformClient->searchTeamFolders($request);
/** @var TeamFolderSearchResult $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedLocation = DataformClient::locationName('[PROJECT]', '[LOCATION]');
search_team_folders_sample($formattedLocation);
}
setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy.
Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
The async variant is DataformClient::setIamPolicyAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Iam\V1\SetIamPolicyRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Iam\V1\Policy |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;
/**
* @param string $resource REQUIRED: The resource for which the policy is being specified.
* See the operation documentation for the appropriate value for this field.
*/
function set_iam_policy_sample(string $resource): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$policy = new Policy();
$request = (new SetIamPolicyRequest())
->setResource($resource)
->setPolicy($policy);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $dataformClient->setIamPolicy($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
set_iam_policy_sample($resource);
}
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.
The async variant is DataformClient::testIamPermissionsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Iam\V1\TestIamPermissionsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Iam\V1\TestIamPermissionsResponse |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
/**
* @param string $resource REQUIRED: The resource for which the policy detail is being requested.
* See the operation documentation for the appropriate value for this field.
* @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
* wildcards (such as '*' or 'storage.*') are not allowed. For more
* information see
* [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
*/
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$permissions = [$permissionsElement,];
$request = (new TestIamPermissionsRequest())
->setResource($resource)
->setPermissions($permissions);
// Call the API and handle any network failures.
try {
/** @var TestIamPermissionsResponse $response */
$response = $dataformClient->testIamPermissions($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
$permissionsElement = '[PERMISSIONS]';
test_iam_permissions_sample($resource, $permissionsElement);
}
updateConfig
Update default config for a given project and location.
Note: This method does not fully implement
AIP/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.
The async variant is DataformClient::updateConfigAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\UpdateConfigRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\Config |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\Config;
use Google\Cloud\Dataform\V1beta1\UpdateConfigRequest;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function update_config_sample(): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$config = new Config();
$request = (new UpdateConfigRequest())
->setConfig($config);
// Call the API and handle any network failures.
try {
/** @var Config $response */
$response = $dataformClient->updateConfig($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
updateFolder
Updates a single Folder.
The async variant is DataformClient::updateFolderAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\UpdateFolderRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\Folder |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\Folder;
use Google\Cloud\Dataform\V1beta1\UpdateFolderRequest;
/**
* @param string $folderDisplayName The Folder's user-friendly name.
*/
function update_folder_sample(string $folderDisplayName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$folder = (new Folder())
->setDisplayName($folderDisplayName);
$request = (new UpdateFolderRequest())
->setFolder($folder);
// Call the API and handle any network failures.
try {
/** @var Folder $response */
$response = $dataformClient->updateFolder($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$folderDisplayName = '[DISPLAY_NAME]';
update_folder_sample($folderDisplayName);
}
updateReleaseConfig
Updates a single ReleaseConfig.
Note: This method does not fully implement
AIP/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.
The async variant is DataformClient::updateReleaseConfigAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\UpdateReleaseConfigRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\ReleaseConfig |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\ReleaseConfig;
use Google\Cloud\Dataform\V1beta1\UpdateReleaseConfigRequest;
/**
* @param string $releaseConfigGitCommitish Git commit/tag/branch name at which the repository should be
* compiled. Must exist in the remote repository. Examples:
* - a commit SHA: `12ade345`
* - a tag: `tag1`
* - a branch name: `branch1`
*/
function update_release_config_sample(string $releaseConfigGitCommitish): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$releaseConfig = (new ReleaseConfig())
->setGitCommitish($releaseConfigGitCommitish);
$request = (new UpdateReleaseConfigRequest())
->setReleaseConfig($releaseConfig);
// Call the API and handle any network failures.
try {
/** @var ReleaseConfig $response */
$response = $dataformClient->updateReleaseConfig($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$releaseConfigGitCommitish = '[GIT_COMMITISH]';
update_release_config_sample($releaseConfigGitCommitish);
}
updateRepository
Updates a single Repository.
Note: This method does not fully implement
AIP/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.
The async variant is DataformClient::updateRepositoryAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\UpdateRepositoryRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\Repository |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\Repository;
use Google\Cloud\Dataform\V1beta1\UpdateRepositoryRequest;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function update_repository_sample(): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$repository = new Repository();
$request = (new UpdateRepositoryRequest())
->setRepository($repository);
// Call the API and handle any network failures.
try {
/** @var Repository $response */
$response = $dataformClient->updateRepository($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
updateTeamFolder
Updates a single TeamFolder.
The async variant is DataformClient::updateTeamFolderAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\UpdateTeamFolderRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\TeamFolder |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\TeamFolder;
use Google\Cloud\Dataform\V1beta1\UpdateTeamFolderRequest;
/**
* @param string $teamFolderDisplayName The TeamFolder's user-friendly name.
*/
function update_team_folder_sample(string $teamFolderDisplayName): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$teamFolder = (new TeamFolder())
->setDisplayName($teamFolderDisplayName);
$request = (new UpdateTeamFolderRequest())
->setTeamFolder($teamFolder);
// Call the API and handle any network failures.
try {
/** @var TeamFolder $response */
$response = $dataformClient->updateTeamFolder($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$teamFolderDisplayName = '[DISPLAY_NAME]';
update_team_folder_sample($teamFolderDisplayName);
}
updateWorkflowConfig
Updates a single WorkflowConfig.
Note: This method does not fully implement
AIP/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.
The async variant is DataformClient::updateWorkflowConfigAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\UpdateWorkflowConfigRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\WorkflowConfig |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\UpdateWorkflowConfigRequest;
use Google\Cloud\Dataform\V1beta1\WorkflowConfig;
/**
* @param string $formattedWorkflowConfigReleaseConfig The name of the release config whose release_compilation_result
* should be executed. Must be in the format
* `projects/*/locations/*/repositories/*/releaseConfigs/*`. Please see
* {@see DataformClient::releaseConfigName()} for help formatting this field.
*/
function update_workflow_config_sample(string $formattedWorkflowConfigReleaseConfig): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$workflowConfig = (new WorkflowConfig())
->setReleaseConfig($formattedWorkflowConfigReleaseConfig);
$request = (new UpdateWorkflowConfigRequest())
->setWorkflowConfig($workflowConfig);
// Call the API and handle any network failures.
try {
/** @var WorkflowConfig $response */
$response = $dataformClient->updateWorkflowConfig($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedWorkflowConfigReleaseConfig = DataformClient::releaseConfigName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[RELEASE_CONFIG]'
);
update_workflow_config_sample($formattedWorkflowConfigReleaseConfig);
}
writeFile
Writes to a file (inside a Workspace).
The async variant is DataformClient::writeFileAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\WriteFileRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataform\V1beta1\WriteFileResponse |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Dataform\V1beta1\WriteFileRequest;
use Google\Cloud\Dataform\V1beta1\WriteFileResponse;
/**
* @param string $formattedWorkspace The workspace's name. Please see
* {@see DataformClient::workspaceName()} for help formatting this field.
* @param string $path The file.
* @param string $contents The file's contents.
*/
function write_file_sample(string $formattedWorkspace, string $path, string $contents): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new WriteFileRequest())
->setWorkspace($formattedWorkspace)
->setPath($path)
->setContents($contents);
// Call the API and handle any network failures.
try {
/** @var WriteFileResponse $response */
$response = $dataformClient->writeFile($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedWorkspace = DataformClient::workspaceName(
'[PROJECT]',
'[LOCATION]',
'[REPOSITORY]',
'[WORKSPACE]'
);
$path = '[PATH]';
$contents = '...';
write_file_sample($formattedWorkspace, $path, $contents);
}
cancelOperation
Starts asynchronous cancellation on a long-running operation. The server
makes a best effort to cancel the operation, but success is not
guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Clients can use
Operations.GetOperation or
other methods to check whether the cancellation succeeded or whether the
operation completed despite cancellation. On successful cancellation,
the operation is not deleted; instead, it becomes an operation with
an Operation.error value with a
google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
The async variant is DataformClient::cancelOperationAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\LongRunning\CancelOperationRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\LongRunning\CancelOperationRequest;
/**
* @param string $name The name of the operation resource to be cancelled.
*/
function cancel_operation_sample(string $name): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new CancelOperationRequest())
->setName($name);
// Call the API and handle any network failures.
try {
$dataformClient->cancelOperation($request);
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$name = '[NAME]';
cancel_operation_sample($name);
}
deleteOperation
Deletes a long-running operation. This method indicates that the client is
no longer interested in the operation result. It does not cancel the
operation. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED.
The async variant is DataformClient::deleteOperationAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\LongRunning\DeleteOperationRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\LongRunning\DeleteOperationRequest;
/**
* @param string $name The name of the operation resource to be deleted.
*/
function delete_operation_sample(string $name): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new DeleteOperationRequest())
->setName($name);
// Call the API and handle any network failures.
try {
$dataformClient->deleteOperation($request);
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$name = '[NAME]';
delete_operation_sample($name);
}
getOperation
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
The async variant is DataformClient::getOperationAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\LongRunning\GetOperationRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\LongRunning\Operation |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\LongRunning\GetOperationRequest;
use Google\LongRunning\Operation;
/**
* @param string $name The name of the operation resource.
*/
function get_operation_sample(string $name): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new GetOperationRequest())
->setName($name);
// Call the API and handle any network failures.
try {
/** @var Operation $response */
$response = $dataformClient->getOperation($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$name = '[NAME]';
get_operation_sample($name);
}
listOperations
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED.
The async variant is DataformClient::listOperationsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\LongRunning\ListOperationsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\LongRunning\ListOperationsRequest;
use Google\LongRunning\Operation;
/**
* @param string $name The name of the operation's parent resource.
* @param string $filter The standard list filter.
*/
function list_operations_sample(string $name, string $filter): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = (new ListOperationsRequest())
->setName($name)
->setFilter($filter);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataformClient->listOperations($request);
/** @var Operation $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$name = '[NAME]';
$filter = '[FILTER]';
list_operations_sample($name, $filter);
}
getLocation
Gets information about a location.
The async variant is DataformClient::getLocationAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Location\Location |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function get_location_sample(): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = new GetLocationRequest();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $dataformClient->getLocation($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
listLocations
Lists information about the supported locations for this service.
This method can be called in two ways:
List all public locations: Use the path GET /v1/locations.
List project-visible locations: Use the path
GET /v1/projects/{project_id}/locations. This may include public
locations as well as private or other locations specifically visible
to the project.
The async variant is DataformClient::listLocationsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataform\V1beta1\Client\DataformClient;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function list_locations_sample(): void
{
// Create a client.
$dataformClient = new DataformClient();
// Prepare the request message.
$request = new ListLocationsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataformClient->listLocations($request);
/** @var Location $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
cancelWorkflowInvocationAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\CancelWorkflowInvocationRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\CancelWorkflowInvocationResponse> |
|
commitRepositoryChangesAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\CommitRepositoryChangesRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\CommitRepositoryChangesResponse> |
|
commitWorkspaceChangesAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\CommitWorkspaceChangesRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\CommitWorkspaceChangesResponse> |
|
computeRepositoryAccessTokenStatusAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\ComputeRepositoryAccessTokenStatusRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\ComputeRepositoryAccessTokenStatusResponse> |
|
createCompilationResultAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\CreateCompilationResultRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\CompilationResult> |
|
createFolderAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\CreateFolderRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\Folder> |
|
createReleaseConfigAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\CreateReleaseConfigRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\ReleaseConfig> |
|
createRepositoryAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\CreateRepositoryRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\Repository> |
|
createTeamFolderAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\CreateTeamFolderRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\TeamFolder> |
|
createWorkflowConfigAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\CreateWorkflowConfigRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\WorkflowConfig> |
|
createWorkflowInvocationAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\CreateWorkflowInvocationRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\WorkflowInvocation> |
|
createWorkspaceAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\CreateWorkspaceRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\Workspace> |
|
deleteFolderAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\DeleteFolderRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
|
deleteReleaseConfigAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\DeleteReleaseConfigRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
|
deleteRepositoryAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\DeleteRepositoryRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
|
deleteTeamFolderAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\DeleteTeamFolderRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
|
deleteWorkflowConfigAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\DeleteWorkflowConfigRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
|
deleteWorkflowInvocationAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\DeleteWorkflowInvocationRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
|
deleteWorkspaceAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\DeleteWorkspaceRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
|
fetchFileDiffAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\FetchFileDiffRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\FetchFileDiffResponse> |
|
fetchFileGitStatusesAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\FetchFileGitStatusesRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\FetchFileGitStatusesResponse> |
|
fetchGitAheadBehindAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\FetchGitAheadBehindRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\FetchGitAheadBehindResponse> |
|
fetchRemoteBranchesAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\FetchRemoteBranchesRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\FetchRemoteBranchesResponse> |
|
fetchRepositoryHistoryAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\FetchRepositoryHistoryRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
getCompilationResultAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\GetCompilationResultRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\CompilationResult> |
|
getConfigAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\GetConfigRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\Config> |
|
getFolderAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\GetFolderRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\Folder> |
|
getIamPolicyAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Iam\V1\GetIamPolicyRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy> |
|
getReleaseConfigAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\GetReleaseConfigRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\ReleaseConfig> |
|
getRepositoryAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\GetRepositoryRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\Repository> |
|
getTeamFolderAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\GetTeamFolderRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\TeamFolder> |
|
getWorkflowConfigAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\GetWorkflowConfigRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\WorkflowConfig> |
|
getWorkflowInvocationAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\GetWorkflowInvocationRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\WorkflowInvocation> |
|
getWorkspaceAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\GetWorkspaceRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\Workspace> |
|
installNpmPackagesAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\InstallNpmPackagesRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\InstallNpmPackagesResponse> |
|
listCompilationResultsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\ListCompilationResultsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
listReleaseConfigsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\ListReleaseConfigsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
listRepositoriesAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\ListRepositoriesRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
listWorkflowConfigsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\ListWorkflowConfigsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
listWorkflowInvocationsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\ListWorkflowInvocationsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
listWorkspacesAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\ListWorkspacesRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
makeDirectoryAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\MakeDirectoryRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\MakeDirectoryResponse> |
|
moveDirectoryAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\MoveDirectoryRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\MoveDirectoryResponse> |
|
moveFileAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\MoveFileRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\MoveFileResponse> |
|
moveFolderAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\MoveFolderRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
moveRepositoryAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\MoveRepositoryRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
pullGitCommitsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\PullGitCommitsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\PullGitCommitsResponse> |
|
pushGitCommitsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\PushGitCommitsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\PushGitCommitsResponse> |
|
queryCompilationResultActionsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\QueryCompilationResultActionsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
queryDirectoryContentsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\QueryDirectoryContentsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
queryFolderContentsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\QueryFolderContentsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
queryRepositoryDirectoryContentsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\QueryRepositoryDirectoryContentsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
queryTeamFolderContentsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\QueryTeamFolderContentsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
queryUserRootContentsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\QueryUserRootContentsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
queryWorkflowInvocationActionsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\QueryWorkflowInvocationActionsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
readFileAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\ReadFileRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\ReadFileResponse> |
|
readRepositoryFileAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\ReadRepositoryFileRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\ReadRepositoryFileResponse> |
|
removeDirectoryAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\RemoveDirectoryRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\RemoveDirectoryResponse> |
|
removeFileAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\RemoveFileRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\RemoveFileResponse> |
|
resetWorkspaceChangesAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\ResetWorkspaceChangesRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\ResetWorkspaceChangesResponse> |
|
searchFilesAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\SearchFilesRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
searchTeamFoldersAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\SearchTeamFoldersRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
setIamPolicyAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Iam\V1\SetIamPolicyRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy> |
|
testIamPermissionsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Iam\V1\TestIamPermissionsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\TestIamPermissionsResponse> |
|
updateConfigAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\UpdateConfigRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\Config> |
|
updateFolderAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\UpdateFolderRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\Folder> |
|
updateReleaseConfigAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\UpdateReleaseConfigRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\ReleaseConfig> |
|
updateRepositoryAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\UpdateRepositoryRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\Repository> |
|
updateTeamFolderAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\UpdateTeamFolderRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\TeamFolder> |
|
updateWorkflowConfigAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\UpdateWorkflowConfigRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\WorkflowConfig> |
|
writeFileAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Dataform\V1beta1\WriteFileRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataform\V1beta1\WriteFileResponse> |
|
cancelOperationAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\LongRunning\CancelOperationRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
|
deleteOperationAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\LongRunning\DeleteOperationRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
|
getOperationAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\LongRunning\GetOperationRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\LongRunning\Operation> |
|
listOperationsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\LongRunning\ListOperationsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
getLocationAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location> |
|
listLocationsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
| Returns | |
|---|---|
| Type | Description |
Google\LongRunning\Client\OperationsClient |
|
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
| Parameters | |
|---|---|
| Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse |
|
static::compilationResultName
Formats a string containing the fully-qualified path to represent a compilation_result resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
repository |
string
|
compilationResult |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted compilation_result resource. |
static::configName
Formats a string containing the fully-qualified path to represent a config resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted config resource. |
static::cryptoKeyName
Formats a string containing the fully-qualified path to represent a crypto_key resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
keyRing |
string
|
cryptoKey |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted crypto_key resource. |
static::cryptoKeyVersionName
Formats a string containing the fully-qualified path to represent a crypto_key_version resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
keyRing |
string
|
cryptoKey |
string
|
cryptoKeyVersion |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted crypto_key_version resource. |
static::folderName
Formats a string containing the fully-qualified path to represent a folder resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
folder |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted folder resource. |
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted location resource. |
static::notebookRuntimeTemplateName
Formats a string containing the fully-qualified path to represent a notebook_runtime_template resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
notebookRuntimeTemplate |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted notebook_runtime_template resource. |
static::releaseConfigName
Formats a string containing the fully-qualified path to represent a release_config resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
repository |
string
|
releaseConfig |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted release_config resource. |
static::repositoryName
Formats a string containing the fully-qualified path to represent a repository resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
repository |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted repository resource. |
static::secretVersionName
Formats a string containing the fully-qualified path to represent a secret_version resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
secret |
string
|
version |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted secret_version resource. |
static::teamFolderName
Formats a string containing the fully-qualified path to represent a team_folder resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
teamFolder |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted team_folder resource. |
static::workflowConfigName
Formats a string containing the fully-qualified path to represent a workflow_config resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
repository |
string
|
workflowConfig |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted workflow_config resource. |
static::workflowInvocationName
Formats a string containing the fully-qualified path to represent a workflow_invocation resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
repository |
string
|
workflowInvocation |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted workflow_invocation resource. |
static::workspaceName
Formats a string containing the fully-qualified path to represent a workspace resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
repository |
string
|
workspace |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted workspace resource. |
static::parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- compilationResult: projects/{project}/locations/{location}/repositories/{repository}/compilationResults/{compilation_result}
- config: projects/{project}/locations/{location}/config
- cryptoKey: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}
- cryptoKeyVersion: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}
- folder: projects/{project}/locations/{location}/folders/{folder}
- location: projects/{project}/locations/{location}
- notebookRuntimeTemplate: projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}
- releaseConfig: projects/{project}/locations/{location}/repositories/{repository}/releaseConfigs/{release_config}
- repository: projects/{project}/locations/{location}/repositories/{repository}
- secretVersion: projects/{project}/secrets/{secret}/versions/{version}
- teamFolder: projects/{project}/locations/{location}/teamFolders/{team_folder}
- workflowConfig: projects/{project}/locations/{location}/repositories/{repository}/workflowConfigs/{workflow_config}
- workflowInvocation: projects/{project}/locations/{location}/repositories/{repository}/workflowInvocations/{workflow_invocation}
- workspace: projects/{project}/locations/{location}/repositories/{repository}/workspaces/{workspace}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
| Parameters | |
|---|---|
| Name | Description |
formattedName |
string
The formatted name string |
template |
?string
Optional name of template to match |
| Returns | |
|---|---|
| Type | Description |
array |
An associative array from name component IDs to component values. |