Reference documentation and code samples for the Google Cloud Data Fusion V1 Client class DataFusionClient.
Service Description: Service for creating and managing Data Fusion instances.
Data Fusion enables ETL developers to build code-free, data integration pipelines via a point-and-click UI.
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 \ DataFusion \ V1 \ ClientMethods
__construct
Constructor.
options
array
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
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage : In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important : If you accept a credential configuration (credential JSON/File/Stream) from an external source for authentication to Google Cloud Platform, you must validate it before providing it to any Google API or library. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. For more information https://cloud.google.com/docs/authentication/external/externally-sourced-credentials
↳ 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 false
.
↳ 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 rest
or grpc
. Defaults to grpc
if gRPC support is detected on the system. Advanced usage
: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface
object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ 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
createInstance
Creates a new Data Fusion instance in the specified project and location.
The async variant is DataFusionClient::createInstanceAsync() .
request
Google\Cloud\DataFusion\V1\CreateInstanceRequest
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\ApiCore\OperationResponse;
use Google\Cloud\DataFusion\V1\Client\DataFusionClient;
use Google\Cloud\DataFusion\V1\CreateInstanceRequest;
use Google\Cloud\DataFusion\V1\Instance;
use Google\Rpc\Status;
/**
* @param string $formattedParent The instance's project and location in the format
* projects/{project}/locations/{location}. Please see
* {@see DataFusionClient::locationName()} for help formatting this field.
* @param string $instanceId The name of the instance to create.
*/
function create_instance_sample(string $formattedParent, string $instanceId): void
{
// Create a client.
$dataFusionClient = new DataFusionClient();
// Prepare the request message.
$request = (new CreateInstanceRequest())
->setParent($formattedParent)
->setInstanceId($instanceId);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataFusionClient->createInstance($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Instance $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} 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
{
$formattedParent = DataFusionClient::locationName('[PROJECT]', '[LOCATION]');
$instanceId = '[INSTANCE_ID]';
create_instance_sample($formattedParent, $instanceId);
}
deleteInstance
Deletes a single Date Fusion instance.
The async variant is DataFusionClient::deleteInstanceAsync() .
request
Google\Cloud\DataFusion\V1\DeleteInstanceRequest
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\ApiCore\OperationResponse;
use Google\Cloud\DataFusion\V1\Client\DataFusionClient;
use Google\Cloud\DataFusion\V1\DeleteInstanceRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The instance resource name in the format
* projects/{project}/locations/{location}/instances/{instance}
* Please see {@see DataFusionClient::instanceName()} for help formatting this field.
*/
function delete_instance_sample(string $formattedName): void
{
// Create a client.
$dataFusionClient = new DataFusionClient();
// Prepare the request message.
$request = (new DeleteInstanceRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataFusionClient->deleteInstance($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 = DataFusionClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
delete_instance_sample($formattedName);
}
getInstance
Gets details of a single Data Fusion instance.
The async variant is DataFusionClient::getInstanceAsync() .
request
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\DataFusion\V1\Client\DataFusionClient;
use Google\Cloud\DataFusion\V1\GetInstanceRequest;
use Google\Cloud\DataFusion\V1\Instance;
/**
* @param string $formattedName The instance resource name in the format
* projects/{project}/locations/{location}/instances/{instance}. Please see
* {@see DataFusionClient::instanceName()} for help formatting this field.
*/
function get_instance_sample(string $formattedName): void
{
// Create a client.
$dataFusionClient = new DataFusionClient();
// Prepare the request message.
$request = (new GetInstanceRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Instance $response */
$response = $dataFusionClient->getInstance($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 = DataFusionClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
get_instance_sample($formattedName);
}
listAvailableVersions
Lists possible versions for Data Fusion instances in the specified project and location.
The async variant is DataFusionClient::listAvailableVersionsAsync() .
request
Google\Cloud\DataFusion\V1\ListAvailableVersionsRequest
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\ApiCore\PagedListResponse;
use Google\Cloud\DataFusion\V1\Client\DataFusionClient;
use Google\Cloud\DataFusion\V1\ListAvailableVersionsRequest;
use Google\Cloud\DataFusion\V1\Version;
/**
* @param string $formattedParent The project and location for which to retrieve instance information
* in the format projects/{project}/locations/{location}. Please see
* {@see DataFusionClient::locationName()} for help formatting this field.
*/
function list_available_versions_sample(string $formattedParent): void
{
// Create a client.
$dataFusionClient = new DataFusionClient();
// Prepare the request message.
$request = (new ListAvailableVersionsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataFusionClient->listAvailableVersions($request);
/** @var Version $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 = DataFusionClient::locationName('[PROJECT]', '[LOCATION]');
list_available_versions_sample($formattedParent);
}
listInstances
Lists Data Fusion instances in the specified project and location.
The async variant is DataFusionClient::listInstancesAsync() .
request
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\ApiCore\PagedListResponse;
use Google\Cloud\DataFusion\V1\Client\DataFusionClient;
use Google\Cloud\DataFusion\V1\Instance;
use Google\Cloud\DataFusion\V1\ListInstancesRequest;
/**
* @param string $formattedParent The project and location for which to retrieve instance information
* in the format projects/{project}/locations/{location}. If the location is
* specified as '-' (wildcard), then all regions available to the project
* are queried, and the results are aggregated. Please see
* {@see DataFusionClient::locationName()} for help formatting this field.
*/
function list_instances_sample(string $formattedParent): void
{
// Create a client.
$dataFusionClient = new DataFusionClient();
// Prepare the request message.
$request = (new ListInstancesRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataFusionClient->listInstances($request);
/** @var Instance $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 = DataFusionClient::locationName('[PROJECT]', '[LOCATION]');
list_instances_sample($formattedParent);
}
restartInstance
Restart a single Data Fusion instance.
At the end of an operation instance is fully restarted.
The async variant is DataFusionClient::restartInstanceAsync() .
request
Google\Cloud\DataFusion\V1\RestartInstanceRequest
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\ApiCore\OperationResponse;
use Google\Cloud\DataFusion\V1\Client\DataFusionClient;
use Google\Cloud\DataFusion\V1\Instance;
use Google\Cloud\DataFusion\V1\RestartInstanceRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName Name of the Data Fusion instance which need to be restarted in the form of
* projects/{project}/locations/{location}/instances/{instance}
* Please see {@see DataFusionClient::instanceName()} for help formatting this field.
*/
function restart_instance_sample(string $formattedName): void
{
// Create a client.
$dataFusionClient = new DataFusionClient();
// Prepare the request message.
$request = (new RestartInstanceRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataFusionClient->restartInstance($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Instance $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} 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 = DataFusionClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
restart_instance_sample($formattedName);
}
updateInstance
Updates a single Data Fusion instance.
The async variant is DataFusionClient::updateInstanceAsync() .
request
Google\Cloud\DataFusion\V1\UpdateInstanceRequest
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\ApiCore\OperationResponse;
use Google\Cloud\DataFusion\V1\Client\DataFusionClient;
use Google\Cloud\DataFusion\V1\Instance;
use Google\Cloud\DataFusion\V1\Instance\Type;
use Google\Cloud\DataFusion\V1\UpdateInstanceRequest;
use Google\Rpc\Status;
/**
* @param int $instanceType Instance type.
*/
function update_instance_sample(int $instanceType): void
{
// Create a client.
$dataFusionClient = new DataFusionClient();
// Prepare the request message.
$instance = (new Instance())
->setType($instanceType);
$request = (new UpdateInstanceRequest())
->setInstance($instance);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataFusionClient->updateInstance($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Instance $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} 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
{
$instanceType = Type::TYPE_UNSPECIFIED;
update_instance_sample($instanceType);
}
createInstanceAsync
optionalArgs
array
deleteInstanceAsync
optionalArgs
array
getInstanceAsync
optionalArgs
array
listAvailableVersionsAsync
optionalArgs
array
listInstancesAsync
optionalArgs
array
restartInstanceAsync
optionalArgs
array
updateInstanceAsync
optionalArgs
array
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
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.
operationName
string
The name of the long running operation
methodName
string
The name of the method used to start the operation
static::cryptoKeyName
Formats a string containing the fully-qualified path to represent a crypto_key resource.
project
string
location
string
keyRing
string
cryptoKey
string
string
static::instanceName
Formats a string containing the fully-qualified path to represent a instance resource.
project
string
location
string
instance
string
string
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
project
string
location
string
string
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
- cryptoKey: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}
- instance: projects/{project}/locations/{location}/instances/{instance}
- location: projects/{project}/locations/{location}
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.
formattedName
string
The formatted name string
template
?string
Optional name of template to match
array
