Google Cloud Dataplex V1 Client - Class ContentServiceClient (0.1.6)

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.
`↳ 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.

createContent

Create a content.

Sample code:

$contentServiceClient = new ContentServiceClient();
try {
    $formattedParent = $contentServiceClient->lakeName('[PROJECT]', '[LOCATION]', '[LAKE]');
    $content = new Content();
    $response = $contentServiceClient->createContent($formattedParent, $content);
} finally {
    $contentServiceClient->close();
}

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 {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\Cloud\Dataplex\V1\Content`

deleteContent

Delete a content.

Sample code:

$contentServiceClient = new ContentServiceClient();
try {
    $formattedName = $contentServiceClient->contentName('[PROJECT]', '[LOCATION]', '[LAKE]', '[CONTENT]');
    $contentServiceClient->deleteContent($formattedName);
} finally {
    $contentServiceClient->close();
}

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 {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

getContent

Get a content resource.

Sample code:

$contentServiceClient = new ContentServiceClient();
try {
    $formattedName = $contentServiceClient->contentName('[PROJECT]', '[LOCATION]', '[LAKE]', '[CONTENT]');
    $response = $contentServiceClient->getContent($formattedName);
} finally {
    $contentServiceClient->close();
}

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 {@see}
`↳ 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.

Returns
Type	Description
`Google\Cloud\Dataplex\V1\Content`

listContent

List content.

Sample code:

$contentServiceClient = new ContentServiceClient();
try {
    $formattedParent = $contentServiceClient->lakeName('[PROJECT]', '[LOCATION]', '[LAKE]');
    // Iterate over pages of elements
    $pagedResponse = $contentServiceClient->listContent($formattedParent);
    foreach ($pagedResponse->iteratePages() as $page) {
        foreach ($page as $element) {
            // doSomethingWith($element);
        }
    }
    // Alternatively:
    // Iterate through all elements
    $pagedResponse = $contentServiceClient->listContent($formattedParent);
    foreach ($pagedResponse->iterateAllElements() as $element) {
        // doSomethingWith($element);
    }
} finally {
    $contentServiceClient->close();
}

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 {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

updateContent

Update a content. Only supports full resource update.

Sample code:

$contentServiceClient = new ContentServiceClient();
try {
    $updateMask = new FieldMask();
    $content = new Content();
    $response = $contentServiceClient->updateContent($updateMask, $content);
} finally {
    $contentServiceClient->close();
}

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 `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.

Returns
Type	Description
`Google\Cloud\Dataplex\V1\Content`

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.