Reference documentation and code samples for the Google Cloud Dataplex V1 Client class DataplexServiceClient.
Service Description: Dataplex service provides data lakes as a service. The primary resources offered by this service are Lakes, Zones and Assets which collectively allow a data administrator to organize, manage, secure and catalog data across their organization located across cloud projects in a variety of storage systems including Cloud Storage and BigQuery.
This class is currently experimental and may be subject to changes.
Methods
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
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
assetName
Formats a string containing the fully-qualified path to represent a asset resource.
project
string
location
string
lake
string
zone
string
asset
string
string
environmentName
Formats a string containing the fully-qualified path to represent a environment resource.
project
string
location
string
lake
string
environment
string
string
jobName
Formats a string containing the fully-qualified path to represent a job resource.
project
string
location
string
lake
string
task
string
job
string
string
lakeName
Formats a string containing the fully-qualified path to represent a lake resource.
project
string
location
string
lake
string
string
locationName
Formats a string containing the fully-qualified path to represent a location resource.
project
string
location
string
string
taskName
Formats a string containing the fully-qualified path to represent a task resource.
project
string
location
string
lake
string
task
string
string
zoneName
Formats a string containing the fully-qualified path to represent a zone resource.
project
string
location
string
lake
string
zone
string
string
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
- asset: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/assets/{asset}
- environment: projects/{project}/locations/{location}/lakes/{lake}/environments/{environment}
- job: projects/{project}/locations/{location}/lakes/{lake}/tasks/{task}/jobs/{job}
- lake: projects/{project}/locations/{location}/lakes/{lake}
- location: projects/{project}/locations/{location}
- task: projects/{project}/locations/{location}/lakes/{lake}/tasks/{task}
- zone: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}
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
__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.
↳ 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.
__call
Handles execution of the async variants for each documented method.
method
mixed
args
mixed
cancelJob
Cancel jobs running for the task resource.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::cancelJobAsync() .
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.
createAsset
Creates an asset resource.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::createAssetAsync() .
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.
createEnvironment
Create an environment resource.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::createEnvironmentAsync() .
request
Google\Cloud\Dataplex\V1\CreateEnvironmentRequest
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.
createLake
Creates a lake resource.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::createLakeAsync() .
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.
createTask
Creates a task resource within a lake.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::createTaskAsync() .
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.
createZone
Creates a zone resource within a lake.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::createZoneAsync() .
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.
deleteAsset
Deletes an asset resource. The referenced storage resource is detached (default) or deleted based on the associated Lifecycle policy.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::deleteAssetAsync() .
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.
deleteEnvironment
Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::deleteEnvironmentAsync() .
request
Google\Cloud\Dataplex\V1\DeleteEnvironmentRequest
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.
deleteLake
Deletes a lake resource. All zones within the lake must be deleted before the lake can be deleted.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::deleteLakeAsync() .
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.
deleteTask
Delete the task resource.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::deleteTaskAsync() .
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.
deleteZone
Deletes a zone resource. All assets within a zone must be deleted before the zone can be deleted.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::deleteZoneAsync() .
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.
getAsset
Retrieves an asset resource.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::getAssetAsync() .
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.
getEnvironment
Get environment resource.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::getEnvironmentAsync() .
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.
getJob
Get job resource.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::getJobAsync() .
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.
getLake
Retrieves a lake resource.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::getLakeAsync() .
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.
getTask
Get task resource.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::getTaskAsync() .
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.
getZone
Retrieves a zone resource.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::getZoneAsync() .
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.
listAssetActions
Lists action resources in an asset.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::listAssetActionsAsync() .
request
Google\Cloud\Dataplex\V1\ListAssetActionsRequest
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.
listAssets
Lists asset resources in a zone.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::listAssetsAsync() .
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.
listEnvironments
Lists environments under the given lake.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::listEnvironmentsAsync() .
request
Google\Cloud\Dataplex\V1\ListEnvironmentsRequest
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.
listJobs
Lists Jobs under the given task.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::listJobsAsync() .
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.
listLakeActions
Lists action resources in a lake.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::listLakeActionsAsync() .
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.
listLakes
Lists lake resources in a project and location.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::listLakesAsync() .
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.
listSessions
Lists session resources in an environment.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::listSessionsAsync() .
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.
listTasks
Lists tasks under the given lake.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::listTasksAsync() .
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.
listZoneActions
Lists action resources in a zone.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::listZoneActionsAsync() .
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.
listZones
Lists zone resources in a lake.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::listZonesAsync() .
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.
runTask
Run an on demand execution of a Task.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::runTaskAsync() .
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.
updateAsset
Updates an asset resource.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::updateAssetAsync() .
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.
updateEnvironment
Update the environment resource.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::updateEnvironmentAsync() .
request
Google\Cloud\Dataplex\V1\UpdateEnvironmentRequest
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.
updateLake
Updates a lake resource.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::updateLakeAsync() .
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.
updateTask
Update the task resource.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::updateTaskAsync() .
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.
updateZone
Updates a zone resource.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::updateZoneAsync() .
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.
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 Google\Cloud\Dataplex\V1\Client\BaseClient\self::getIamPolicyAsync() .
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.
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 Google\Cloud\Dataplex\V1\Client\BaseClient\self::setIamPolicyAsync() .
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.
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 Google\Cloud\Dataplex\V1\Client\BaseClient\self::testIamPermissionsAsync() .
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.
getLocation
Gets information about a location.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::getLocationAsync() .
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.
listLocations
Lists information about the supported locations for this service.
The async variant is Google\Cloud\Dataplex\V1\Client\BaseClient\self::listLocationsAsync() .
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.
