Stackdriver Logging V2 Client - Class GetSettingsRequest (1.29.0)

Reference documentation and code samples for the Stackdriver Logging V2 Client class GetSettingsRequest.

The parameters to GetSettings.

See Enabling CMEK for Log Router for more information.

Generated from protobuf message google.logging.v2.GetSettingsRequest

Namespace

Google \ Cloud \ Logging \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required. The resource for which to retrieve settings. "projects/[PROJECT_ID]/settings" "organizations/[ORGANIZATION_ID]/settings" "billingAccounts/[BILLING_ACCOUNT_ID]/settings" "folders/[FOLDER_ID]/settings" For example: `"organizations/12345/settings"` 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.

getName

Required. The resource for which to retrieve settings.

"projects/[PROJECT_ID]/settings" "organizations/[ORGANIZATION_ID]/settings" "billingAccounts/[BILLING_ACCOUNT_ID]/settings" "folders/[FOLDER_ID]/settings" For example: "organizations/12345/settings" 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.

Returns
Type	Description
`string`

setName

Required. The resource for which to retrieve settings.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameter

Name Description

name

string

Required. The resource for which to retrieve settings.

"projects/[PROJECT_ID]/settings" "organizations/[ORGANIZATION_ID]/settings" "billingAccounts/[BILLING_ACCOUNT_ID]/settings" "folders/[FOLDER_ID]/settings"

For example:

"organizations/12345/settings"

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. Please see Google\Cloud\Logging\V2\ConfigServiceV2Client::settingsName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\Logging\V2\GetSettingsRequest`