Google Cloud Data Catalog Lineage V1 Client - Class ConfigManagementServiceClient (1.3.0)

Reference documentation and code samples for the Google Cloud Data Catalog Lineage V1 Client class ConfigManagementServiceClient.

Service Description: Lineage Config Management service. Config Management service is used to manage the configuration for Data Lineage. These Configs define different configuration options for Lineage customers to control behaviour of lineage systems.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Namespace

Google \ Cloud \ DataCatalog \ Lineage \ ConfigManagement \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array\|Google\ApiCore\Options\ClientOptions` 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`	`FetchAuthTokenInterface\|CredentialsWrapper` This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly `use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\DataCatalog\Lineage\ConfigManagement\V1\ConfigManagementServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new ConfigManagementServiceClient(['credentials' => $creds]);` https://cloud.google.com/docs/authentication/external/externally-sourced-credentials
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.
`↳ logger`	`false\|LoggerInterface` A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag
`↳ universeDomain`	`string` The service domain for the client. Defaults to 'googleapis.com'.

getConfig

Get the Config for a given resource.

The async variant is ConfigManagementServiceClient::getConfigAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataCatalog\Lineage\ConfigManagement\V1\GetConfigRequest` 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.

Returns
Type	Description
`Google\Cloud\DataCatalog\Lineage\ConfigManagement\V1\Config`

updateConfig

Update the Config for a given resource.

The async variant is ConfigManagementServiceClient::updateConfigAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DataCatalog\Lineage\ConfigManagement\V1\UpdateConfigRequest` 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.

Returns
Type	Description
`Google\Cloud\DataCatalog\Lineage\ConfigManagement\V1\Config`

getConfigAsync

Parameters
Name	Description
`request`	`Google\Cloud\DataCatalog\Lineage\ConfigManagement\V1\GetConfigRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\DataCatalog\Lineage\ConfigManagement\V1\Config>`

updateConfigAsync

Parameters
Name	Description
`request`	`Google\Cloud\DataCatalog\Lineage\ConfigManagement\V1\UpdateConfigRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\DataCatalog\Lineage\ConfigManagement\V1\Config>`

static::configName

Formats a string containing the fully-qualified path to represent a config resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted config resource.

static::folderLocationConfigName

Formats a string containing the fully-qualified path to represent a folder_location_config resource.

Parameters
Name	Description
`folder`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted folder_location_config resource.

static::organizationLocationConfigName

Formats a string containing the fully-qualified path to represent a organization_location_config resource.

Parameters
Name	Description
`organization`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted organization_location_config resource.

static::projectLocationConfigName

Formats a string containing the fully-qualified path to represent a project_location_config resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted project_location_config resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

config: projects/{project}/locations/{location}/config
folderLocationConfig: folders/{folder}/locations/{location}/config
organizationLocationConfig: organizations/{organization}/locations/{location}/config
projectLocationConfig: projects/{project}/locations/{location}/config

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.

Google Cloud Data Catalog Lineage V1 Client - Class ConfigManagementServiceClient (1.3.0) Stay organized with collections Save and categorize content based on your preferences.