Reference documentation and code samples for the Stackdriver Logging V2 Client class ConfigServiceV2Client.
Service Description: Service for configuring sinks used to route log entries.
This class is currently experimental and may be subject to changes.
Namespace
Google \ Cloud \ Logging \ V2 \ ClientMethods
__construct
Constructor.
options
array
Optional. Options for configuring the service API wrapper.
↳ apiEndpoint
string
The address of the API remote host. May optionally include the port, formatted as "
↳ credentials
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage : In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to false
.
↳ clientConfig
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport
string|TransportInterface
The transport used for executing network requests. May be either the string rest
or grpc
. Defaults to grpc
if gRPC support is detected on the system. Advanced usage
: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface
object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.
copyLogEntries
Copies a set of log entries from a log bucket to a Cloud Storage bucket.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::copyLogEntriesAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
createBucket
Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::createBucketAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
createBucketAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createExclusion
Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::createExclusionAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
createLink
Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::createLinkAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
createSink
Creates a sink that exports specified log entries to a destination. The
export of newly-ingested log entries begins immediately, unless the sink's writer_identity
is not permitted to write to the destination. A sink can
export log entries only from the resource owning the sink.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::createSinkAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
createView
Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::createViewAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
deleteBucket
Deletes a log bucket.
Changes the bucket's lifecycle_state
to the DELETE_REQUESTED
state.
After 7 days, the bucket will be purged and all log entries in the bucket
will be permanently deleted.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::deleteBucketAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
deleteExclusion
Deletes an exclusion in the _Default sink.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::deleteExclusionAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
deleteLink
Deletes a link. This will also delete the corresponding BigQuery linked dataset.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::deleteLinkAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
deleteSink
Deletes a sink. If the sink has a unique writer_identity
, then that
service account is also deleted.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::deleteSinkAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
deleteView
Deletes a view on a log bucket.
If an UNAVAILABLE
error is returned, this indicates that system is not in
a state where it can delete the view. If this occurs, please try again in a
few minutes.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::deleteViewAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
getBucket
Gets a log bucket.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::getBucketAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
getCmekSettings
Gets the Logging CMEK settings for the given resource.
Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.
See Enabling CMEK for Log Router for more information.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::getCmekSettingsAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
getExclusion
Gets the description of an exclusion in the _Default sink.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::getExclusionAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
getLink
Gets a link.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::getLinkAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
getSettings
Gets the Log Router settings for the given resource.
Note: Settings for the Log Router can be get for Google Cloud projects, folders, organizations and billing accounts. Currently it can only be configured for organizations. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.
See Enabling CMEK for Log Router for more information.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::getSettingsAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
getSink
Gets a sink.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::getSinkAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
getView
Gets a view on a log bucket..
The async variant is self::getViewAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
listBuckets
Lists log buckets.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::listBucketsAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
listExclusions
Lists all the exclusions on the _Default sink in a parent resource.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::listExclusionsAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
listLinks
Lists links.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::listLinksAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
listSinks
Lists sinks.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::listSinksAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
listViews
Lists views on a log bucket.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::listViewsAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
undeleteBucket
Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::undeleteBucketAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
updateBucket
Updates a log bucket.
If the bucket has a lifecycle_state
of DELETE_REQUESTED
, then FAILED_PRECONDITION
will be returned.
After a bucket has been created, the bucket's location cannot be changed.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::updateBucketAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
updateBucketAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateCmekSettings
Updates the Log Router CMEK settings for the given resource.
Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.
UpdateCmekSettings
will fail if 1) kms_key_name
is invalid, or 2) the associated service
account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter
role assigned for the key, or
3) access to the key is disabled.
See Enabling CMEK for Log Router for more information.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::updateCmekSettingsAsync() .
request
Google\Cloud\Logging\V2\UpdateCmekSettingsRequest
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.
updateExclusion
Changes one or more properties of an existing exclusion in the _Default sink.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::updateExclusionAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
updateSettings
Updates the Log Router settings for the given resource.
Note: Settings for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.
UpdateSettings
will fail if 1) kms_key_name
is invalid, or 2) the associated service
account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter
role assigned for the key, or
3) access to the key is disabled. 4) location_id
is not supported by
Logging. 5) location_id
violate OrgPolicy.
See Enabling CMEK for Log Router for more information.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::updateSettingsAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
updateSink
Updates a sink. This method replaces the following fields in the existing
sink with values from the new sink: destination
, and filter
.
The updated sink might also have a new writer_identity
; see the unique_writer_identity
field.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::updateSinkAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
updateView
Updates a view on a log bucket. This method replaces the following fields
in the existing view with values from the new view: filter
.
If an UNAVAILABLE
error is returned, this indicates that system is not in
a state where it can update the view. If this occurs, please try again in a
few minutes.
The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::updateViewAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
copyLogEntriesAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createBucketAsyncAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createExclusionAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createLinkAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createSinkAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createViewAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteBucketAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteExclusionAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteLinkAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteSinkAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteViewAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getBucketAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getCmekSettingsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getExclusionAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getLinkAsync
GuzzleHttp\Promise\PromiseInterface
getSettingsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getSinkAsync
GuzzleHttp\Promise\PromiseInterface
getViewAsync
GuzzleHttp\Promise\PromiseInterface
listBucketsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listExclusionsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listLinksAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listSinksAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listViewsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
undeleteBucketAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateBucketAsyncAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateCmekSettingsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateExclusionAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateSettingsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateSinkAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateViewAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
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
static::billingAccountName
Formats a string containing the fully-qualified path to represent a billing_account resource.
billingAccount
string
string
static::billingAccountCmekSettingsName
Formats a string containing the fully-qualified path to represent a billing_account_cmekSettings resource.
billingAccount
string
string
static::billingAccountExclusionName
Formats a string containing the fully-qualified path to represent a billing_account_exclusion resource.
billingAccount
string
exclusion
string
string
static::billingAccountLocationName
Formats a string containing the fully-qualified path to represent a billing_account_location resource.
billingAccount
string
location
string
string
static::billingAccountLocationBucketName
Formats a string containing the fully-qualified path to represent a billing_account_location_bucket resource.
billingAccount
string
location
string
bucket
string
string
static::billingAccountLocationBucketLinkName
Formats a string containing the fully-qualified path to represent a billing_account_location_bucket_link resource.
billingAccount
string
location
string
bucket
string
link
string
string
static::billingAccountLocationBucketViewName
Formats a string containing the fully-qualified path to represent a billing_account_location_bucket_view resource.
billingAccount
string
location
string
bucket
string
view
string
string
static::billingAccountSettingsName
Formats a string containing the fully-qualified path to represent a billing_account_settings resource.
billingAccount
string
string
static::billingAccountSinkName
Formats a string containing the fully-qualified path to represent a billing_account_sink resource.
billingAccount
string
sink
string
string
static::cmekSettingsName
Formats a string containing the fully-qualified path to represent a cmek_settings resource.
project
string
string
static::folderName
Formats a string containing the fully-qualified path to represent a folder resource.
folder
string
string
static::folderCmekSettingsName
Formats a string containing the fully-qualified path to represent a folder_cmekSettings resource.
folder
string
string
static::folderExclusionName
Formats a string containing the fully-qualified path to represent a folder_exclusion resource.
folder
string
exclusion
string
string
static::folderLocationName
Formats a string containing the fully-qualified path to represent a folder_location resource.
folder
string
location
string
string
static::folderLocationBucketName
Formats a string containing the fully-qualified path to represent a folder_location_bucket resource.
folder
string
location
string
bucket
string
string
static::folderLocationBucketLinkName
Formats a string containing the fully-qualified path to represent a folder_location_bucket_link resource.
folder
string
location
string
bucket
string
link
string
string
static::folderLocationBucketViewName
Formats a string containing the fully-qualified path to represent a folder_location_bucket_view resource.
folder
string
location
string
bucket
string
view
string
string
static::folderSettingsName
Formats a string containing the fully-qualified path to represent a folder_settings resource.
folder
string
string
static::folderSinkName
Formats a string containing the fully-qualified path to represent a folder_sink resource.
folder
string
sink
string
string
static::linkName
Formats a string containing the fully-qualified path to represent a link resource.
project
string
location
string
bucket
string
link
string
string
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
project
string
location
string
string
static::logBucketName
Formats a string containing the fully-qualified path to represent a log_bucket resource.
project
string
location
string
bucket
string
string
static::logExclusionName
Formats a string containing the fully-qualified path to represent a log_exclusion resource.
project
string
exclusion
string
string
static::logSinkName
Formats a string containing the fully-qualified path to represent a log_sink resource.
project
string
sink
string
string
static::logViewName
Formats a string containing the fully-qualified path to represent a log_view resource.
project
string
location
string
bucket
string
view
string
string
static::organizationName
Formats a string containing the fully-qualified path to represent a organization resource.
organization
string
string
static::organizationCmekSettingsName
Formats a string containing the fully-qualified path to represent a organization_cmekSettings resource.
organization
string
string
static::organizationExclusionName
Formats a string containing the fully-qualified path to represent a organization_exclusion resource.
organization
string
exclusion
string
string
static::organizationLocationName
Formats a string containing the fully-qualified path to represent a organization_location resource.
organization
string
location
string
string
static::organizationLocationBucketName
Formats a string containing the fully-qualified path to represent a organization_location_bucket resource.
organization
string
location
string
bucket
string
string
static::organizationLocationBucketLinkName
Formats a string containing the fully-qualified path to represent a organization_location_bucket_link resource.
organization
string
location
string
bucket
string
link
string
string
static::organizationLocationBucketViewName
Formats a string containing the fully-qualified path to represent a organization_location_bucket_view resource.
organization
string
location
string
bucket
string
view
string
string
static::organizationSettingsName
Formats a string containing the fully-qualified path to represent a organization_settings resource.
organization
string
string
static::organizationSinkName
Formats a string containing the fully-qualified path to represent a organization_sink resource.
organization
string
sink
string
string
static::projectName
Formats a string containing the fully-qualified path to represent a project resource.
project
string
string
static::projectCmekSettingsName
Formats a string containing the fully-qualified path to represent a project_cmekSettings resource.
project
string
string
static::projectExclusionName
Formats a string containing the fully-qualified path to represent a project_exclusion resource.
project
string
exclusion
string
string
static::projectLocationBucketName
Formats a string containing the fully-qualified path to represent a project_location_bucket resource.
project
string
location
string
bucket
string
string
static::projectLocationBucketLinkName
Formats a string containing the fully-qualified path to represent a project_location_bucket_link resource.
project
string
location
string
bucket
string
link
string
string
static::projectLocationBucketViewName
Formats a string containing the fully-qualified path to represent a project_location_bucket_view resource.
project
string
location
string
bucket
string
view
string
string
static::projectSettingsName
Formats a string containing the fully-qualified path to represent a project_settings resource.
project
string
string
static::projectSinkName
Formats a string containing the fully-qualified path to represent a project_sink resource.
project
string
sink
string
string
static::settingsName
Formats a string containing the fully-qualified path to represent a settings resource.
project
string
string
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
- billingAccount: billingAccounts/{billing_account}
- billingAccountCmekSettings: billingAccounts/{billing_account}/cmekSettings
- billingAccountExclusion: billingAccounts/{billing_account}/exclusions/{exclusion}
- billingAccountLocation: billingAccounts/{billing_account}/locations/{location}
- billingAccountLocationBucket: billingAccounts/{billing_account}/locations/{location}/buckets/{bucket}
- billingAccountLocationBucketLink: billingAccounts/{billing_account}/locations/{location}/buckets/{bucket}/links/{link}
- billingAccountLocationBucketView: billingAccounts/{billing_account}/locations/{location}/buckets/{bucket}/views/{view}
- billingAccountSettings: billingAccounts/{billing_account}/settings
- billingAccountSink: billingAccounts/{billing_account}/sinks/{sink}
- cmekSettings: projects/{project}/cmekSettings
- folder: folders/{folder}
- folderCmekSettings: folders/{folder}/cmekSettings
- folderExclusion: folders/{folder}/exclusions/{exclusion}
- folderLocation: folders/{folder}/locations/{location}
- folderLocationBucket: folders/{folder}/locations/{location}/buckets/{bucket}
- folderLocationBucketLink: folders/{folder}/locations/{location}/buckets/{bucket}/links/{link}
- folderLocationBucketView: folders/{folder}/locations/{location}/buckets/{bucket}/views/{view}
- folderSettings: folders/{folder}/settings
- folderSink: folders/{folder}/sinks/{sink}
- link: projects/{project}/locations/{location}/buckets/{bucket}/links/{link}
- location: projects/{project}/locations/{location}
- logBucket: projects/{project}/locations/{location}/buckets/{bucket}
- logExclusion: projects/{project}/exclusions/{exclusion}
- logSink: projects/{project}/sinks/{sink}
- logView: projects/{project}/locations/{location}/buckets/{bucket}/views/{view}
- organization: organizations/{organization}
- organizationCmekSettings: organizations/{organization}/cmekSettings
- organizationExclusion: organizations/{organization}/exclusions/{exclusion}
- organizationLocation: organizations/{organization}/locations/{location}
- organizationLocationBucket: organizations/{organization}/locations/{location}/buckets/{bucket}
- organizationLocationBucketLink: organizations/{organization}/locations/{location}/buckets/{bucket}/links/{link}
- organizationLocationBucketView: organizations/{organization}/locations/{location}/buckets/{bucket}/views/{view}
- organizationSettings: organizations/{organization}/settings
- organizationSink: organizations/{organization}/sinks/{sink}
- project: projects/{project}
- projectCmekSettings: projects/{project}/cmekSettings
- projectExclusion: projects/{project}/exclusions/{exclusion}
- projectLocationBucket: projects/{project}/locations/{location}/buckets/{bucket}
- projectLocationBucketLink: projects/{project}/locations/{location}/buckets/{bucket}/links/{link}
- projectLocationBucketView: projects/{project}/locations/{location}/buckets/{bucket}/views/{view}
- projectSettings: projects/{project}/settings
- projectSink: projects/{project}/sinks/{sink}
- settings: projects/{project}/settings
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
