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 adminstrator 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 provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedName = $dataplexServiceClient->jobName('[PROJECT]', '[LOCATION]', '[LAKE]', '[TASK]', '[JOB]');
$dataplexServiceClient->cancelJob($formattedName);
} finally {
$dataplexServiceClient->close();
}
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.
Methods
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
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
__construct
Constructor.
options
array
Optional. Options for configuring the service API wrapper.
↳ serviceAddress
string
Deprecated. This option will be removed in a future major release. Please utilize the $apiEndpoint
option instead.
↳ 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 {@see} object or {@see} 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 {@see} .
↳ 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 {@see} object. Note that when this object is provided, any settings in $transportConfig, and any $serviceAddress 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 {@see} and {@see} 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.
cancelJob
Cancel jobs running for the task resource.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedName = $dataplexServiceClient->jobName('[PROJECT]', '[LOCATION]', '[LAKE]', '[TASK]', '[JOB]');
$dataplexServiceClient->cancelJob($formattedName);
} finally {
$dataplexServiceClient->close();
}
name
string
Required. The resource name of the job: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}/job/{job_id}
.
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
createAsset
Creates an asset resource.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedParent = $dataplexServiceClient->zoneName('[PROJECT]', '[LOCATION]', '[LAKE]', '[ZONE]');
$assetId = 'asset_id';
$asset = new Asset();
$operationResponse = $dataplexServiceClient->createAsset($formattedParent, $assetId, $asset);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $dataplexServiceClient->createAsset($formattedParent, $assetId, $asset);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $dataplexServiceClient->resumeOperation($operationName, 'createAsset');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$dataplexServiceClient->close();
}
parent
string
Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}
assetId
string
Required. Asset identifier. This ID will be used to generate names such as table names when publishing metadata to Hive Metastore and BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique within the zone.
asset
optionalArgs
array
Optional.
↳ validateOnly
bool
Optional. Only validate the request, but do not perform mutations. The default is false.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
createEnvironment
Create an environment resource.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedParent = $dataplexServiceClient->lakeName('[PROJECT]', '[LOCATION]', '[LAKE]');
$environmentId = 'environment_id';
$environment = new Environment();
$operationResponse = $dataplexServiceClient->createEnvironment($formattedParent, $environmentId, $environment);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $dataplexServiceClient->createEnvironment($formattedParent, $environmentId, $environment);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $dataplexServiceClient->resumeOperation($operationName, 'createEnvironment');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$dataplexServiceClient->close();
}
parent
string
Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}
environmentId
string
Required. Environment identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the lake.
environment
optionalArgs
array
Optional.
↳ validateOnly
bool
Optional. Only validate the request, but do not perform mutations. The default is false.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
createLake
Creates a lake resource.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedParent = $dataplexServiceClient->locationName('[PROJECT]', '[LOCATION]');
$lakeId = 'lake_id';
$lake = new Lake();
$operationResponse = $dataplexServiceClient->createLake($formattedParent, $lakeId, $lake);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $dataplexServiceClient->createLake($formattedParent, $lakeId, $lake);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $dataplexServiceClient->resumeOperation($operationName, 'createLake');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$dataplexServiceClient->close();
}
parent
string
Required. The resource name of the lake location, of the form: projects/{project_number}/locations/{location_id} where location_id
refers to a GCP region.
lakeId
string
Required. Lake identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique within the customer project / location.
lake
optionalArgs
array
Optional.
↳ validateOnly
bool
Optional. Only validate the request, but do not perform mutations. The default is false.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
createTask
Creates a task resource within a lake.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedParent = $dataplexServiceClient->lakeName('[PROJECT]', '[LOCATION]', '[LAKE]');
$taskId = 'task_id';
$task = new Task();
$operationResponse = $dataplexServiceClient->createTask($formattedParent, $taskId, $task);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $dataplexServiceClient->createTask($formattedParent, $taskId, $task);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $dataplexServiceClient->resumeOperation($operationName, 'createTask');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$dataplexServiceClient->close();
}
parent
string
Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}
.
taskId
string
Required. Task identifier.
task
optionalArgs
array
Optional.
↳ validateOnly
bool
Optional. Only validate the request, but do not perform mutations. The default is false.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
createZone
Creates a zone resource within a lake.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedParent = $dataplexServiceClient->lakeName('[PROJECT]', '[LOCATION]', '[LAKE]');
$zoneId = 'zone_id';
$zone = new Zone();
$operationResponse = $dataplexServiceClient->createZone($formattedParent, $zoneId, $zone);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $dataplexServiceClient->createZone($formattedParent, $zoneId, $zone);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $dataplexServiceClient->resumeOperation($operationName, 'createZone');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$dataplexServiceClient->close();
}
parent
string
Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}
.
zoneId
string
Required. Zone identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique across all lakes from all locations in a project. * Must not be one of the reserved IDs (i.e. "default", "global-temp")
zone
optionalArgs
array
Optional.
↳ validateOnly
bool
Optional. Only validate the request, but do not perform mutations. The default is false.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
deleteAsset
Deletes an asset resource. The referenced storage resource is detached (default) or deleted based on the associated Lifecycle policy.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedName = $dataplexServiceClient->assetName('[PROJECT]', '[LOCATION]', '[LAKE]', '[ZONE]', '[ASSET]');
$operationResponse = $dataplexServiceClient->deleteAsset($formattedName);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// operation succeeded and returns no value
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $dataplexServiceClient->deleteAsset($formattedName);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $dataplexServiceClient->resumeOperation($operationName, 'deleteAsset');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
// operation succeeded and returns no value
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$dataplexServiceClient->close();
}
name
string
Required. The resource name of the asset: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}
.
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
deleteEnvironment
Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedName = $dataplexServiceClient->environmentName('[PROJECT]', '[LOCATION]', '[LAKE]', '[ENVIRONMENT]');
$operationResponse = $dataplexServiceClient->deleteEnvironment($formattedName);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// operation succeeded and returns no value
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $dataplexServiceClient->deleteEnvironment($formattedName);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $dataplexServiceClient->resumeOperation($operationName, 'deleteEnvironment');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
// operation succeeded and returns no value
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$dataplexServiceClient->close();
}
name
string
Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}`
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
deleteLake
Deletes a lake resource. All zones within the lake must be deleted before the lake can be deleted.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedName = $dataplexServiceClient->lakeName('[PROJECT]', '[LOCATION]', '[LAKE]');
$operationResponse = $dataplexServiceClient->deleteLake($formattedName);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// operation succeeded and returns no value
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $dataplexServiceClient->deleteLake($formattedName);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $dataplexServiceClient->resumeOperation($operationName, 'deleteLake');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
// operation succeeded and returns no value
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$dataplexServiceClient->close();
}
name
string
Required. The resource name of the lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
deleteTask
Delete the task resource.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedName = $dataplexServiceClient->taskName('[PROJECT]', '[LOCATION]', '[LAKE]', '[TASK]');
$operationResponse = $dataplexServiceClient->deleteTask($formattedName);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// operation succeeded and returns no value
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $dataplexServiceClient->deleteTask($formattedName);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $dataplexServiceClient->resumeOperation($operationName, 'deleteTask');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
// operation succeeded and returns no value
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$dataplexServiceClient->close();
}
name
string
Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}
.
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
deleteZone
Deletes a zone resource. All assets within a zone must be deleted before the zone can be deleted.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedName = $dataplexServiceClient->zoneName('[PROJECT]', '[LOCATION]', '[LAKE]', '[ZONE]');
$operationResponse = $dataplexServiceClient->deleteZone($formattedName);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// operation succeeded and returns no value
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $dataplexServiceClient->deleteZone($formattedName);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $dataplexServiceClient->resumeOperation($operationName, 'deleteZone');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
// operation succeeded and returns no value
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$dataplexServiceClient->close();
}
name
string
Required. The resource name of the zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}
.
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
getAsset
Retrieves an asset resource.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedName = $dataplexServiceClient->assetName('[PROJECT]', '[LOCATION]', '[LAKE]', '[ZONE]', '[ASSET]');
$response = $dataplexServiceClient->getAsset($formattedName);
} finally {
$dataplexServiceClient->close();
}
name
string
Required. The resource name of the asset: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}
.
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
getEnvironment
Get environment resource.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedName = $dataplexServiceClient->environmentName('[PROJECT]', '[LOCATION]', '[LAKE]', '[ENVIRONMENT]');
$response = $dataplexServiceClient->getEnvironment($formattedName);
} finally {
$dataplexServiceClient->close();
}
name
string
Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
getJob
Get job resource.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedName = $dataplexServiceClient->jobName('[PROJECT]', '[LOCATION]', '[LAKE]', '[TASK]', '[JOB]');
$response = $dataplexServiceClient->getJob($formattedName);
} finally {
$dataplexServiceClient->close();
}
name
string
Required. The resource name of the job: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}
.
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
getLake
Retrieves a lake resource.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedName = $dataplexServiceClient->lakeName('[PROJECT]', '[LOCATION]', '[LAKE]');
$response = $dataplexServiceClient->getLake($formattedName);
} finally {
$dataplexServiceClient->close();
}
name
string
Required. The resource name of the lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}
.
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
getTask
Get task resource.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedName = $dataplexServiceClient->taskName('[PROJECT]', '[LOCATION]', '[LAKE]', '[TASK]');
$response = $dataplexServiceClient->getTask($formattedName);
} finally {
$dataplexServiceClient->close();
}
name
string
Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{tasks_id}
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
getZone
Retrieves a zone resource.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedName = $dataplexServiceClient->zoneName('[PROJECT]', '[LOCATION]', '[LAKE]', '[ZONE]');
$response = $dataplexServiceClient->getZone($formattedName);
} finally {
$dataplexServiceClient->close();
}
name
string
Required. The resource name of the zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}
.
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
listAssetActions
Lists action resources in an asset.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedParent = $dataplexServiceClient->assetName('[PROJECT]', '[LOCATION]', '[LAKE]', '[ZONE]', '[ASSET]');
// Iterate over pages of elements
$pagedResponse = $dataplexServiceClient->listAssetActions($formattedParent);
foreach ($pagedResponse->iteratePages() as $page) {
foreach ($page as $element) {
// doSomethingWith($element);
}
}
// Alternatively:
// Iterate through all elements
$pagedResponse = $dataplexServiceClient->listAssetActions($formattedParent);
foreach ($pagedResponse->iterateAllElements() as $element) {
// doSomethingWith($element);
}
} finally {
$dataplexServiceClient->close();
}
parent
string
Required. The resource name of the parent asset: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}
.
optionalArgs
array
Optional.
↳ pageSize
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
↳ pageToken
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
listAssets
Lists asset resources in a zone.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedParent = $dataplexServiceClient->zoneName('[PROJECT]', '[LOCATION]', '[LAKE]', '[ZONE]');
// Iterate over pages of elements
$pagedResponse = $dataplexServiceClient->listAssets($formattedParent);
foreach ($pagedResponse->iteratePages() as $page) {
foreach ($page as $element) {
// doSomethingWith($element);
}
}
// Alternatively:
// Iterate through all elements
$pagedResponse = $dataplexServiceClient->listAssets($formattedParent);
foreach ($pagedResponse->iterateAllElements() as $element) {
// doSomethingWith($element);
}
} finally {
$dataplexServiceClient->close();
}
parent
string
Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}
.
optionalArgs
array
Optional.
↳ pageSize
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
↳ pageToken
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
↳ filter
string
Optional. Filter request.
↳ orderBy
string
Optional. Order by fields for the result.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
listEnvironments
Lists environments under the given lake.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedParent = $dataplexServiceClient->lakeName('[PROJECT]', '[LOCATION]', '[LAKE]');
// Iterate over pages of elements
$pagedResponse = $dataplexServiceClient->listEnvironments($formattedParent);
foreach ($pagedResponse->iteratePages() as $page) {
foreach ($page as $element) {
// doSomethingWith($element);
}
}
// Alternatively:
// Iterate through all elements
$pagedResponse = $dataplexServiceClient->listEnvironments($formattedParent);
foreach ($pagedResponse->iterateAllElements() as $element) {
// doSomethingWith($element);
}
} finally {
$dataplexServiceClient->close();
}
parent
string
Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}
optionalArgs
array
Optional.
↳ pageSize
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
↳ pageToken
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
↳ filter
string
Optional. Filter request.
↳ orderBy
string
Optional. Order by fields for the result.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
listJobs
Lists Jobs under the given task.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedParent = $dataplexServiceClient->taskName('[PROJECT]', '[LOCATION]', '[LAKE]', '[TASK]');
// Iterate over pages of elements
$pagedResponse = $dataplexServiceClient->listJobs($formattedParent);
foreach ($pagedResponse->iteratePages() as $page) {
foreach ($page as $element) {
// doSomethingWith($element);
}
}
// Alternatively:
// Iterate through all elements
$pagedResponse = $dataplexServiceClient->listJobs($formattedParent);
foreach ($pagedResponse->iterateAllElements() as $element) {
// doSomethingWith($element);
}
} finally {
$dataplexServiceClient->close();
}
parent
string
Required. The resource name of the parent environment: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}
.
optionalArgs
array
Optional.
↳ pageSize
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
↳ pageToken
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
listLakeActions
Lists action resources in a lake.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedParent = $dataplexServiceClient->lakeName('[PROJECT]', '[LOCATION]', '[LAKE]');
// Iterate over pages of elements
$pagedResponse = $dataplexServiceClient->listLakeActions($formattedParent);
foreach ($pagedResponse->iteratePages() as $page) {
foreach ($page as $element) {
// doSomethingWith($element);
}
}
// Alternatively:
// Iterate through all elements
$pagedResponse = $dataplexServiceClient->listLakeActions($formattedParent);
foreach ($pagedResponse->iterateAllElements() as $element) {
// doSomethingWith($element);
}
} finally {
$dataplexServiceClient->close();
}
parent
string
Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}
optionalArgs
array
Optional.
↳ pageSize
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
↳ pageToken
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
listLakes
Lists lake resources in a project and location.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedParent = $dataplexServiceClient->locationName('[PROJECT]', '[LOCATION]');
// Iterate over pages of elements
$pagedResponse = $dataplexServiceClient->listLakes($formattedParent);
foreach ($pagedResponse->iteratePages() as $page) {
foreach ($page as $element) {
// doSomethingWith($element);
}
}
// Alternatively:
// Iterate through all elements
$pagedResponse = $dataplexServiceClient->listLakes($formattedParent);
foreach ($pagedResponse->iterateAllElements() as $element) {
// doSomethingWith($element);
}
} finally {
$dataplexServiceClient->close();
}
parent
string
Required. The resource name of the lake location, of the form: projects/{project_number}/locations/{location_id}
where location_id
refers to a GCP region.
optionalArgs
array
Optional.
↳ pageSize
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
↳ pageToken
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
↳ filter
string
Optional. Filter request.
↳ orderBy
string
Optional. Order by fields for the result.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
listSessions
Lists session resources in an environment.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedParent = $dataplexServiceClient->environmentName('[PROJECT]', '[LOCATION]', '[LAKE]', '[ENVIRONMENT]');
// Iterate over pages of elements
$pagedResponse = $dataplexServiceClient->listSessions($formattedParent);
foreach ($pagedResponse->iteratePages() as $page) {
foreach ($page as $element) {
// doSomethingWith($element);
}
}
// Alternatively:
// Iterate through all elements
$pagedResponse = $dataplexServiceClient->listSessions($formattedParent);
foreach ($pagedResponse->iterateAllElements() as $element) {
// doSomethingWith($element);
}
} finally {
$dataplexServiceClient->close();
}
parent
string
Required. The resource name of the parent environment: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
optionalArgs
array
Optional.
↳ pageSize
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
↳ pageToken
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
listTasks
Lists tasks under the given lake.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedParent = $dataplexServiceClient->lakeName('[PROJECT]', '[LOCATION]', '[LAKE]');
// Iterate over pages of elements
$pagedResponse = $dataplexServiceClient->listTasks($formattedParent);
foreach ($pagedResponse->iteratePages() as $page) {
foreach ($page as $element) {
// doSomethingWith($element);
}
}
// Alternatively:
// Iterate through all elements
$pagedResponse = $dataplexServiceClient->listTasks($formattedParent);
foreach ($pagedResponse->iterateAllElements() as $element) {
// doSomethingWith($element);
}
} finally {
$dataplexServiceClient->close();
}
parent
string
Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}
.
optionalArgs
array
Optional.
↳ pageSize
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
↳ pageToken
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
↳ filter
string
Optional. Filter request.
↳ orderBy
string
Optional. Order by fields for the result.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
listZoneActions
Lists action resources in a zone.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedParent = $dataplexServiceClient->zoneName('[PROJECT]', '[LOCATION]', '[LAKE]', '[ZONE]');
// Iterate over pages of elements
$pagedResponse = $dataplexServiceClient->listZoneActions($formattedParent);
foreach ($pagedResponse->iteratePages() as $page) {
foreach ($page as $element) {
// doSomethingWith($element);
}
}
// Alternatively:
// Iterate through all elements
$pagedResponse = $dataplexServiceClient->listZoneActions($formattedParent);
foreach ($pagedResponse->iterateAllElements() as $element) {
// doSomethingWith($element);
}
} finally {
$dataplexServiceClient->close();
}
parent
string
Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}
.
optionalArgs
array
Optional.
↳ pageSize
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
↳ pageToken
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
listZones
Lists zone resources in a lake.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$formattedParent = $dataplexServiceClient->lakeName('[PROJECT]', '[LOCATION]', '[LAKE]');
// Iterate over pages of elements
$pagedResponse = $dataplexServiceClient->listZones($formattedParent);
foreach ($pagedResponse->iteratePages() as $page) {
foreach ($page as $element) {
// doSomethingWith($element);
}
}
// Alternatively:
// Iterate through all elements
$pagedResponse = $dataplexServiceClient->listZones($formattedParent);
foreach ($pagedResponse->iterateAllElements() as $element) {
// doSomethingWith($element);
}
} finally {
$dataplexServiceClient->close();
}
parent
string
Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}
.
optionalArgs
array
Optional.
↳ pageSize
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
↳ pageToken
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
↳ filter
string
Optional. Filter request.
↳ orderBy
string
Optional. Order by fields for the result.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
updateAsset
Updates an asset resource.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$updateMask = new FieldMask();
$asset = new Asset();
$operationResponse = $dataplexServiceClient->updateAsset($updateMask, $asset);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $dataplexServiceClient->updateAsset($updateMask, $asset);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $dataplexServiceClient->resumeOperation($operationName, 'updateAsset');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$dataplexServiceClient->close();
}
updateMask
Google\Protobuf\FieldMask
Required. Mask of fields to update.
asset
Google\Cloud\Dataplex\V1\Asset
Required. Update description. Only fields specified in update_mask
are updated.
optionalArgs
array
Optional.
↳ validateOnly
bool
Optional. Only validate the request, but do not perform mutations. The default is false.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
updateEnvironment
Update the environment resource.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$updateMask = new FieldMask();
$environment = new Environment();
$operationResponse = $dataplexServiceClient->updateEnvironment($updateMask, $environment);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $dataplexServiceClient->updateEnvironment($updateMask, $environment);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $dataplexServiceClient->resumeOperation($operationName, 'updateEnvironment');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$dataplexServiceClient->close();
}
updateMask
Google\Protobuf\FieldMask
Required. Mask of fields to update.
environment
Google\Cloud\Dataplex\V1\Environment
Required. Update description. Only fields specified in update_mask
are updated.
optionalArgs
array
Optional.
↳ validateOnly
bool
Optional. Only validate the request, but do not perform mutations. The default is false.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
updateLake
Updates a lake resource.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$updateMask = new FieldMask();
$lake = new Lake();
$operationResponse = $dataplexServiceClient->updateLake($updateMask, $lake);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $dataplexServiceClient->updateLake($updateMask, $lake);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $dataplexServiceClient->resumeOperation($operationName, 'updateLake');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$dataplexServiceClient->close();
}
updateMask
Google\Protobuf\FieldMask
Required. Mask of fields to update.
lake
Google\Cloud\Dataplex\V1\Lake
Required. Update description. Only fields specified in update_mask
are updated.
optionalArgs
array
Optional.
↳ validateOnly
bool
Optional. Only validate the request, but do not perform mutations. The default is false.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
updateTask
Update the task resource.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$updateMask = new FieldMask();
$task = new Task();
$operationResponse = $dataplexServiceClient->updateTask($updateMask, $task);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $dataplexServiceClient->updateTask($updateMask, $task);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $dataplexServiceClient->resumeOperation($operationName, 'updateTask');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$dataplexServiceClient->close();
}
updateMask
Google\Protobuf\FieldMask
Required. Mask of fields to update.
task
Google\Cloud\Dataplex\V1\Task
Required. Update description. Only fields specified in update_mask
are updated.
optionalArgs
array
Optional.
↳ validateOnly
bool
Optional. Only validate the request, but do not perform mutations. The default is false.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
updateZone
Updates a zone resource.
Sample code:
$dataplexServiceClient = new DataplexServiceClient();
try {
$updateMask = new FieldMask();
$zone = new Zone();
$operationResponse = $dataplexServiceClient->updateZone($updateMask, $zone);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $dataplexServiceClient->updateZone($updateMask, $zone);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $dataplexServiceClient->resumeOperation($operationName, 'updateZone');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$dataplexServiceClient->close();
}
updateMask
Google\Protobuf\FieldMask
Required. Mask of fields to update.
zone
Google\Cloud\Dataplex\V1\Zone
Required. Update description. Only fields specified in update_mask
are updated.
optionalArgs
array
Optional.
↳ validateOnly
bool
Optional. Only validate the request, but do not perform mutations. The default is false.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.
Constants
SERVICE_NAME
Value: 'google.cloud.dataplex.v1.DataplexService'
The name of the service.
SERVICE_ADDRESS
Value: 'dataplex.googleapis.com'
The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443
The default port of the service.
CODEGEN_NAME
Value: 'gapic'
The name of the code generator, to be included in the agent header.
