Class Settings.Builder (0.3.0)

public static final class Settings.Builder extends GeneratedMessage.Builder<Settings.Builder> implements SettingsOrBuilder

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

Protobuf type google.cloud.observability.v1.Settings

Implements

SettingsOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public Settings build()
Returns
Type Description
Settings

buildPartial()

public Settings buildPartial()
Returns
Type Description
Settings

clear()

public Settings.Builder clear()
Returns
Type Description
Settings.Builder
Overrides

clearDefaultStorageLocation()

public Settings.Builder clearDefaultStorageLocation()

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

string default_storage_location = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Settings.Builder

This builder for chaining.

clearKmsKeyName()

public Settings.Builder clearKmsKeyName()

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"

string kms_key_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Settings.Builder

This builder for chaining.

clearName()

public Settings.Builder clearName()

Identifier. The resource name of the settings.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
Settings.Builder

This builder for chaining.

clearServiceAccountId()

public Settings.Builder clearServiceAccountId()

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.

string service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Settings.Builder

This builder for chaining.

getDefaultInstanceForType()

public Settings getDefaultInstanceForType()
Returns
Type Description
Settings

getDefaultStorageLocation()

public String getDefaultStorageLocation()

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

string default_storage_location = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The defaultStorageLocation.

getDefaultStorageLocationBytes()

public ByteString getDefaultStorageLocationBytes()

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

string default_storage_location = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for defaultStorageLocation.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getKmsKeyName()

public String 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"

string kms_key_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The kmsKeyName.

getKmsKeyNameBytes()

public ByteString getKmsKeyNameBytes()

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"

string kms_key_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for kmsKeyName.

getName()

public String getName()

Identifier. The resource name of the settings.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the settings.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getServiceAccountId()

public String 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.

string service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The serviceAccountId.

getServiceAccountIdBytes()

public ByteString getServiceAccountIdBytes()

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.

string service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for serviceAccountId.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Settings other)

public Settings.Builder mergeFrom(Settings other)
Parameter
Name Description
other Settings
Returns
Type Description
Settings.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Settings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Settings.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Settings.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Settings.Builder
Overrides

setDefaultStorageLocation(String value)

public Settings.Builder setDefaultStorageLocation(String value)

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

string default_storage_location = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The defaultStorageLocation to set.

Returns
Type Description
Settings.Builder

This builder for chaining.

setDefaultStorageLocationBytes(ByteString value)

public Settings.Builder setDefaultStorageLocationBytes(ByteString value)

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

string default_storage_location = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for defaultStorageLocation to set.

Returns
Type Description
Settings.Builder

This builder for chaining.

setKmsKeyName(String value)

public Settings.Builder setKmsKeyName(String value)

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"

string kms_key_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The kmsKeyName to set.

Returns
Type Description
Settings.Builder

This builder for chaining.

setKmsKeyNameBytes(ByteString value)

public Settings.Builder setKmsKeyNameBytes(ByteString value)

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"

string kms_key_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for kmsKeyName to set.

Returns
Type Description
Settings.Builder

This builder for chaining.

setName(String value)

public Settings.Builder setName(String value)

Identifier. The resource name of the settings.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Settings.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Settings.Builder setNameBytes(ByteString value)

Identifier. The resource name of the settings.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Settings.Builder

This builder for chaining.

setServiceAccountId(String value)

public Settings.Builder setServiceAccountId(String value)

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.

string service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The serviceAccountId to set.

Returns
Type Description
Settings.Builder

This builder for chaining.

setServiceAccountIdBytes(ByteString value)

public Settings.Builder setServiceAccountIdBytes(ByteString value)

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.

string service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for serviceAccountId to set.

Returns
Type Description
Settings.Builder

This builder for chaining.