Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ContentServiceClient.
Service Description: ContentService manages Notebook and SQL Scripts for Dataplex.
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:
$contentServiceClient = new ContentServiceClient();
try {
$formattedParent = $contentServiceClient->lakeName('[PROJECT]', '[LOCATION]', '[LAKE]');
$content = new Content();
$response = $contentServiceClient->createContent($formattedParent, $content);
} finally {
$contentServiceClient->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
contentName
Formats a string containing the fully-qualified path to represent a content resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
lake |
string
|
content |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted content resource. |
lakeName
Formats a string containing the fully-qualified path to represent a lake resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
lake |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted lake resource. |
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
- content: projects/{project}/locations/{location}/lakes/{lake}/content/{content}
- lake: projects/{project}/locations/{location}/lakes/{lake}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
Parameters | |
---|---|
Name | Description |
formattedName |
string
The formatted name string |
template |
string
Optional name of template to match |
Returns | |
---|---|
Type | Description |
array | An associative array from name component IDs to component values. |
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
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 |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
createContent
Create a content.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id} |
content |
Google\Cloud\Dataplex\V1\Content
Required. Content resource. |
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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataplex\V1\Content |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Content;
use Google\Cloud\Dataplex\V1\ContentServiceClient;
/**
* @param string $formattedParent The resource name of the parent lake:
* projects/{project_id}/locations/{location_id}/lakes/{lake_id}
* Please see {@see ContentServiceClient::lakeName()} for help formatting this field.
* @param string $contentPath The path for the Content file, represented as directory
* structure. Unique within a lake. Limited to alphanumerics, hyphens,
* underscores, dots and slashes.
* @param string $contentDataText Content data in string format.
*/
function create_content_sample(
string $formattedParent,
string $contentPath,
string $contentDataText
): void {
// Create a client.
$contentServiceClient = new ContentServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$content = (new Content())
->setPath($contentPath)
->setDataText($contentDataText);
// Call the API and handle any network failures.
try {
/** @var Content $response */
$response = $contentServiceClient->createContent($formattedParent, $content);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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 = ContentServiceClient::lakeName('[PROJECT]', '[LOCATION]', '[LAKE]');
$contentPath = '[PATH]';
$contentDataText = '[DATA_TEXT]';
create_content_sample($formattedParent, $contentPath, $contentDataText);
}
deleteContent
Delete a content.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id} |
optionalArgs |
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\Dataplex\V1\ContentServiceClient;
/**
* @param string $formattedName The resource name of the content:
* projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}
* Please see {@see ContentServiceClient::contentName()} for help formatting this field.
*/
function delete_content_sample(string $formattedName): void
{
// Create a client.
$contentServiceClient = new ContentServiceClient();
// Call the API and handle any network failures.
try {
$contentServiceClient->deleteContent($formattedName);
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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 = ContentServiceClient::contentName(
'[PROJECT]',
'[LOCATION]',
'[LAKE]',
'[CONTENT]'
);
delete_content_sample($formattedName);
}
getContent
Get a content resource.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id} |
optionalArgs |
array
Optional. |
↳ view |
int
Optional. Specify content view to make a partial request. For allowed values, use constants defined on Google\Cloud\Dataplex\V1\GetContentRequest\ContentView |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataplex\V1\Content |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Content;
use Google\Cloud\Dataplex\V1\ContentServiceClient;
/**
* @param string $formattedName The resource name of the content:
* projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}
* Please see {@see ContentServiceClient::contentName()} for help formatting this field.
*/
function get_content_sample(string $formattedName): void
{
// Create a client.
$contentServiceClient = new ContentServiceClient();
// Call the API and handle any network failures.
try {
/** @var Content $response */
$response = $contentServiceClient->getContent($formattedName);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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 = ContentServiceClient::contentName(
'[PROJECT]',
'[LOCATION]',
'[LAKE]',
'[CONTENT]'
);
get_content_sample($formattedName);
}
getIamPolicy
Gets the access control policy for a contentitem resource. A NOT_FOUND
error is returned if the resource does not exist. An empty policy is
returned if the resource exists but does not have a policy set on it.
Caller must have Google IAM dataplex.content.getIamPolicy
permission
on the resource.
Parameters | |
---|---|
Name | Description |
resource |
string
REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
optionalArgs |
array
Optional. |
↳ options |
GetPolicyOptions
OPTIONAL: A |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\Policy |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\ContentServiceClient;
use Google\Cloud\Iam\V1\Policy;
/**
* @param string $resource REQUIRED: The resource for which the policy is being requested.
* See the operation documentation for the appropriate value for this field.
*/
function get_iam_policy_sample(string $resource): void
{
// Create a client.
$contentServiceClient = new ContentServiceClient();
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $contentServiceClient->getIamPolicy($resource);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
get_iam_policy_sample($resource);
}
listContent
List content.
Parameters | |
---|---|
Name | Description |
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. Filters are case-sensitive. The following formats are supported: labels.key1 = "value1" labels:key1 type = "NOTEBOOK" type = "SQL_SCRIPT" These restrictions can be coinjoined with AND, OR and NOT conjunctions. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataplex\V1\Content;
use Google\Cloud\Dataplex\V1\ContentServiceClient;
/**
* @param string $formattedParent The resource name of the parent lake:
* projects/{project_id}/locations/{location_id}/lakes/{lake_id}
* Please see {@see ContentServiceClient::lakeName()} for help formatting this field.
*/
function list_content_sample(string $formattedParent): void
{
// Create a client.
$contentServiceClient = new ContentServiceClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $contentServiceClient->listContent($formattedParent);
/** @var Content $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());
}
}
/**
* 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 = ContentServiceClient::lakeName('[PROJECT]', '[LOCATION]', '[LAKE]');
list_content_sample($formattedParent);
}
setIamPolicy
Sets the access control policy on the specified contentitem resource.
Replaces any existing policy.
Caller must have Google IAM dataplex.content.setIamPolicy
permission
on the resource.
Parameters | |
---|---|
Name | Description |
resource |
string
REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy |
Google\Cloud\Iam\V1\Policy
REQUIRED: The complete policy to be applied to the |
optionalArgs |
array
Optional. |
↳ updateMask |
FieldMask
OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\Policy |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\ContentServiceClient;
use Google\Cloud\Iam\V1\Policy;
/**
* @param string $resource REQUIRED: The resource for which the policy is being specified.
* See the operation documentation for the appropriate value for this field.
*/
function set_iam_policy_sample(string $resource): void
{
// Create a client.
$contentServiceClient = new ContentServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$policy = new Policy();
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $contentServiceClient->setIamPolicy($resource, $policy);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
set_iam_policy_sample($resource);
}
testIamPermissions
Returns the caller's permissions on a resource.
If the resource does not exist, an empty set of
permissions is returned (a NOT_FOUND
error is not returned).
A caller is not required to have Google IAM permission to make this request.
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.
Parameters | |
---|---|
Name | Description |
resource |
string
REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
permissions |
string[]
The set of permissions to check for the |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\TestIamPermissionsResponse |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\ContentServiceClient;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
/**
* @param string $resource REQUIRED: The resource for which the policy detail is being requested.
* See the operation documentation for the appropriate value for this field.
* @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
* wildcards (such as '*' or 'storage.*') are not allowed. For more
* information see
* [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
*/
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
// Create a client.
$contentServiceClient = new ContentServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$permissions = [$permissionsElement,];
// Call the API and handle any network failures.
try {
/** @var TestIamPermissionsResponse $response */
$response = $contentServiceClient->testIamPermissions($resource, $permissions);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
$permissionsElement = '[PERMISSIONS]';
test_iam_permissions_sample($resource, $permissionsElement);
}
updateContent
Update a content. Only supports full resource update.
Parameters | |
---|---|
Name | Description |
updateMask |
Google\Protobuf\FieldMask
Required. Mask of fields to update. |
content |
Google\Cloud\Dataplex\V1\Content
Required. Update description.
Only fields specified in |
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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataplex\V1\Content |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Content;
use Google\Cloud\Dataplex\V1\ContentServiceClient;
use Google\Protobuf\FieldMask;
/**
* @param string $contentPath The path for the Content file, represented as directory
* structure. Unique within a lake. Limited to alphanumerics, hyphens,
* underscores, dots and slashes.
* @param string $contentDataText Content data in string format.
*/
function update_content_sample(string $contentPath, string $contentDataText): void
{
// Create a client.
$contentServiceClient = new ContentServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$updateMask = new FieldMask();
$content = (new Content())
->setPath($contentPath)
->setDataText($contentDataText);
// Call the API and handle any network failures.
try {
/** @var Content $response */
$response = $contentServiceClient->updateContent($updateMask, $content);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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
{
$contentPath = '[PATH]';
$contentDataText = '[DATA_TEXT]';
update_content_sample($contentPath, $contentDataText);
}
getLocation
Gets information about a location.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ name |
string
Resource name for the location. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Location\Location |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\ContentServiceClient;
use Google\Cloud\Location\Location;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function get_location_sample(): void
{
// Create a client.
$contentServiceClient = new ContentServiceClient();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $contentServiceClient->getLocation();
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
listLocations
Lists information about the supported locations for this service.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ name |
string
The resource that owns the locations collection, if applicable. |
↳ filter |
string
The standard list filter. |
↳ 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 Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataplex\V1\ContentServiceClient;
use Google\Cloud\Location\Location;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function list_locations_sample(): void
{
// Create a client.
$contentServiceClient = new ContentServiceClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $contentServiceClient->listLocations();
/** @var Location $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
Constants
SERVICE_NAME
Value: 'google.cloud.dataplex.v1.ContentService'
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.