Google Cloud Observability V1 Client - Class Settings (0.1.0)

Reference documentation and code samples for the Google Cloud Observability V1 Client class Settings.

Describes the settings associated with a project, organization, or folder.

Generated from protobuf message google.cloud.observability.v1.Settings

Namespace

Google \ Cloud \ Observability \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Identifier. The resource name of the settings.
↳ default_storage_location string

Optional. The location which should be used when any regional resources are provisioned by Google Cloud.
↳ service_account_id string

Output only. The service account for the given resource container, such as project or folder. This will be used by Cloud Observability to perform actions in the container's project like access KMS keys or create Links. Always the same service account per resource container regardless of region.
↳ kms_key_name string

Optional. The resource name for the configured Cloud KMS key. KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example: "projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"

getName

Identifier. The resource name of the settings.

Returns
Type Description
string

setName

Identifier. The resource name of the settings.

Parameter
Name Description
var string
Returns
Type Description
$this

getDefaultStorageLocation

Optional. The location which should be used when any regional resources are provisioned by Google Cloud.

Returns
Type Description
string

setDefaultStorageLocation

Optional. The location which should be used when any regional resources are provisioned by Google Cloud.

Parameter
Name Description
var string
Returns
Type Description
$this

getServiceAccountId

Output only. The service account for the given resource container, such as project or folder. This will be used by Cloud Observability to perform actions in the container's project like access KMS keys or create Links.

Always the same service account per resource container regardless of region.

Returns
Type Description
string

setServiceAccountId

Output only. The service account for the given resource container, such as project or folder. This will be used by Cloud Observability to perform actions in the container's project like access KMS keys or create Links.

Always the same service account per resource container regardless of region.

Parameter
Name Description
var string
Returns
Type Description
$this

getKmsKeyName

Optional. The resource name for the configured Cloud KMS key.

KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example: "projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"

Returns
Type Description
string

setKmsKeyName

Optional. The resource name for the configured Cloud KMS key.

KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example: "projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"

Parameter
Name Description
var string
Returns
Type Description
$this