public static final class Settings.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Settings.Builder> implements SettingsOrBuilder
Describes the settings associated with a project, folder, organization, billing account, or flexible resource.Protobuf type
google.logging.v2.Settings
Modifier and Type | Method and Description |
---|---|
Settings.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Settings |
build() |
Settings |
buildPartial() |
Settings.Builder |
clear() |
Settings.Builder |
clearDisableDefaultSink()
Optional.
|
Settings.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Settings.Builder |
clearKmsKeyName()
Optional.
|
Settings.Builder |
clearKmsServiceAccountId()
Output only.
|
Settings.Builder |
clearName()
Output only.
|
Settings.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Settings.Builder |
clearStorageLocation()
Optional.
|
Settings.Builder |
clone() |
Settings |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
boolean |
getDisableDefaultSink()
Optional.
|
String |
getKmsKeyName()
Optional.
|
com.google.protobuf.ByteString |
getKmsKeyNameBytes()
Optional.
|
String |
getKmsServiceAccountId()
Output only.
|
com.google.protobuf.ByteString |
getKmsServiceAccountIdBytes()
Output only.
|
String |
getName()
Output only.
|
com.google.protobuf.ByteString |
getNameBytes()
Output only.
|
String |
getStorageLocation()
Optional.
|
com.google.protobuf.ByteString |
getStorageLocationBytes()
Optional.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
Settings.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Settings.Builder |
mergeFrom(com.google.protobuf.Message other) |
Settings.Builder |
mergeFrom(Settings other) |
Settings.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Settings.Builder |
setDisableDefaultSink(boolean value)
Optional.
|
Settings.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Settings.Builder |
setKmsKeyName(String value)
Optional.
|
Settings.Builder |
setKmsKeyNameBytes(com.google.protobuf.ByteString value)
Optional.
|
Settings.Builder |
setKmsServiceAccountId(String value)
Output only.
|
Settings.Builder |
setKmsServiceAccountIdBytes(com.google.protobuf.ByteString value)
Output only.
|
Settings.Builder |
setName(String value)
Output only.
|
Settings.Builder |
setNameBytes(com.google.protobuf.ByteString value)
Output only.
|
Settings.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
Settings.Builder |
setStorageLocation(String value)
Optional.
|
Settings.Builder |
setStorageLocationBytes(com.google.protobuf.ByteString value)
Optional.
|
Settings.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3.Builder<Settings.Builder>
public Settings.Builder clear()
clear
in interface com.google.protobuf.Message.Builder
clear
in interface com.google.protobuf.MessageLite.Builder
clear
in class com.google.protobuf.GeneratedMessageV3.Builder<Settings.Builder>
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType
in interface com.google.protobuf.Message.Builder
getDescriptorForType
in interface com.google.protobuf.MessageOrBuilder
getDescriptorForType
in class com.google.protobuf.GeneratedMessageV3.Builder<Settings.Builder>
public Settings getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
public Settings build()
build
in interface com.google.protobuf.Message.Builder
build
in interface com.google.protobuf.MessageLite.Builder
public Settings buildPartial()
buildPartial
in interface com.google.protobuf.Message.Builder
buildPartial
in interface com.google.protobuf.MessageLite.Builder
public Settings.Builder clone()
clone
in interface com.google.protobuf.Message.Builder
clone
in interface com.google.protobuf.MessageLite.Builder
clone
in class com.google.protobuf.GeneratedMessageV3.Builder<Settings.Builder>
public Settings.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField
in interface com.google.protobuf.Message.Builder
setField
in class com.google.protobuf.GeneratedMessageV3.Builder<Settings.Builder>
public Settings.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField
in interface com.google.protobuf.Message.Builder
clearField
in class com.google.protobuf.GeneratedMessageV3.Builder<Settings.Builder>
public Settings.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof
in interface com.google.protobuf.Message.Builder
clearOneof
in class com.google.protobuf.GeneratedMessageV3.Builder<Settings.Builder>
public Settings.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField
in interface com.google.protobuf.Message.Builder
setRepeatedField
in class com.google.protobuf.GeneratedMessageV3.Builder<Settings.Builder>
public Settings.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField
in interface com.google.protobuf.Message.Builder
addRepeatedField
in class com.google.protobuf.GeneratedMessageV3.Builder<Settings.Builder>
public Settings.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom
in interface com.google.protobuf.Message.Builder
mergeFrom
in class com.google.protobuf.AbstractMessage.Builder<Settings.Builder>
public Settings.Builder mergeFrom(Settings other)
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3.Builder<Settings.Builder>
public Settings.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom
in interface com.google.protobuf.Message.Builder
mergeFrom
in interface com.google.protobuf.MessageLite.Builder
mergeFrom
in class com.google.protobuf.AbstractMessage.Builder<Settings.Builder>
IOException
public String getName()
Output only. The resource name of the settings.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
getName
in interface SettingsOrBuilder
public com.google.protobuf.ByteString getNameBytes()
Output only. The resource name of the settings.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
getNameBytes
in interface SettingsOrBuilder
public Settings.Builder setName(String value)
Output only. The resource name of the settings.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
value
- The name to set.public Settings.Builder clearName()
Output only. The resource name of the settings.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Settings.Builder setNameBytes(com.google.protobuf.ByteString value)
Output only. The resource name of the settings.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
value
- The bytes for name to set.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"` To enable CMEK for the Log Router, set this field to a valid `kms_key_name` for which the associated service account has the required `roles/cloudkms.cryptoKeyEncrypterDecrypter` role assigned for the key. The Cloud KMS key used by the Log Router can be updated by changing the `kms_key_name` to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked. To disable CMEK for the Log Router, set this field to an empty string. See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL];
getKmsKeyName
in interface SettingsOrBuilder
public com.google.protobuf.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"` To enable CMEK for the Log Router, set this field to a valid `kms_key_name` for which the associated service account has the required `roles/cloudkms.cryptoKeyEncrypterDecrypter` role assigned for the key. The Cloud KMS key used by the Log Router can be updated by changing the `kms_key_name` to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked. To disable CMEK for the Log Router, set this field to an empty string. See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL];
getKmsKeyNameBytes
in interface SettingsOrBuilder
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"` To enable CMEK for the Log Router, set this field to a valid `kms_key_name` for which the associated service account has the required `roles/cloudkms.cryptoKeyEncrypterDecrypter` role assigned for the key. The Cloud KMS key used by the Log Router can be updated by changing the `kms_key_name` to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked. To disable CMEK for the Log Router, set this field to an empty string. See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL];
value
- The kmsKeyName to set.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"` To enable CMEK for the Log Router, set this field to a valid `kms_key_name` for which the associated service account has the required `roles/cloudkms.cryptoKeyEncrypterDecrypter` role assigned for the key. The Cloud KMS key used by the Log Router can be updated by changing the `kms_key_name` to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked. To disable CMEK for the Log Router, set this field to an empty string. See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL];
public Settings.Builder setKmsKeyNameBytes(com.google.protobuf.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"` To enable CMEK for the Log Router, set this field to a valid `kms_key_name` for which the associated service account has the required `roles/cloudkms.cryptoKeyEncrypterDecrypter` role assigned for the key. The Cloud KMS key used by the Log Router can be updated by changing the `kms_key_name` to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked. To disable CMEK for the Log Router, set this field to an empty string. See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL];
value
- The bytes for kmsKeyName to set.public String getKmsServiceAccountId()
Output only. The service account that will be used by the Log Router to access your Cloud KMS key. Before enabling CMEK for Log Router, you must first assign the role `roles/cloudkms.cryptoKeyEncrypterDecrypter` to the service account that the Log Router will use to access your Cloud KMS key. Use [GetSettings][google.logging.v2.ConfigServiceV2.GetSettings] to obtain the service account ID. See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
string kms_service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getKmsServiceAccountId
in interface SettingsOrBuilder
public com.google.protobuf.ByteString getKmsServiceAccountIdBytes()
Output only. The service account that will be used by the Log Router to access your Cloud KMS key. Before enabling CMEK for Log Router, you must first assign the role `roles/cloudkms.cryptoKeyEncrypterDecrypter` to the service account that the Log Router will use to access your Cloud KMS key. Use [GetSettings][google.logging.v2.ConfigServiceV2.GetSettings] to obtain the service account ID. See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
string kms_service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getKmsServiceAccountIdBytes
in interface SettingsOrBuilder
public Settings.Builder setKmsServiceAccountId(String value)
Output only. The service account that will be used by the Log Router to access your Cloud KMS key. Before enabling CMEK for Log Router, you must first assign the role `roles/cloudkms.cryptoKeyEncrypterDecrypter` to the service account that the Log Router will use to access your Cloud KMS key. Use [GetSettings][google.logging.v2.ConfigServiceV2.GetSettings] to obtain the service account ID. See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
string kms_service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
value
- The kmsServiceAccountId to set.public Settings.Builder clearKmsServiceAccountId()
Output only. The service account that will be used by the Log Router to access your Cloud KMS key. Before enabling CMEK for Log Router, you must first assign the role `roles/cloudkms.cryptoKeyEncrypterDecrypter` to the service account that the Log Router will use to access your Cloud KMS key. Use [GetSettings][google.logging.v2.ConfigServiceV2.GetSettings] to obtain the service account ID. See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
string kms_service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Settings.Builder setKmsServiceAccountIdBytes(com.google.protobuf.ByteString value)
Output only. The service account that will be used by the Log Router to access your Cloud KMS key. Before enabling CMEK for Log Router, you must first assign the role `roles/cloudkms.cryptoKeyEncrypterDecrypter` to the service account that the Log Router will use to access your Cloud KMS key. Use [GetSettings][google.logging.v2.ConfigServiceV2.GetSettings] to obtain the service account ID. See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
string kms_service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
value
- The bytes for kmsServiceAccountId to set.public String getStorageLocation()
Optional. The Cloud region that will be used for _Default and _Required log buckets for newly created projects and folders. For example `europe-west1`. This setting does not affect the location of custom log buckets.
string storage_location = 4 [(.google.api.field_behavior) = OPTIONAL];
getStorageLocation
in interface SettingsOrBuilder
public com.google.protobuf.ByteString getStorageLocationBytes()
Optional. The Cloud region that will be used for _Default and _Required log buckets for newly created projects and folders. For example `europe-west1`. This setting does not affect the location of custom log buckets.
string storage_location = 4 [(.google.api.field_behavior) = OPTIONAL];
getStorageLocationBytes
in interface SettingsOrBuilder
public Settings.Builder setStorageLocation(String value)
Optional. The Cloud region that will be used for _Default and _Required log buckets for newly created projects and folders. For example `europe-west1`. This setting does not affect the location of custom log buckets.
string storage_location = 4 [(.google.api.field_behavior) = OPTIONAL];
value
- The storageLocation to set.public Settings.Builder clearStorageLocation()
Optional. The Cloud region that will be used for _Default and _Required log buckets for newly created projects and folders. For example `europe-west1`. This setting does not affect the location of custom log buckets.
string storage_location = 4 [(.google.api.field_behavior) = OPTIONAL];
public Settings.Builder setStorageLocationBytes(com.google.protobuf.ByteString value)
Optional. The Cloud region that will be used for _Default and _Required log buckets for newly created projects and folders. For example `europe-west1`. This setting does not affect the location of custom log buckets.
string storage_location = 4 [(.google.api.field_behavior) = OPTIONAL];
value
- The bytes for storageLocation to set.public boolean getDisableDefaultSink()
Optional. If set to true, the _Default sink in newly created projects and folders will created in a disabled state. This can be used to automatically disable log ingestion if there is already an aggregated sink configured in the hierarchy. The _Default sink can be re-enabled manually if needed.
bool disable_default_sink = 5 [(.google.api.field_behavior) = OPTIONAL];
getDisableDefaultSink
in interface SettingsOrBuilder
public Settings.Builder setDisableDefaultSink(boolean value)
Optional. If set to true, the _Default sink in newly created projects and folders will created in a disabled state. This can be used to automatically disable log ingestion if there is already an aggregated sink configured in the hierarchy. The _Default sink can be re-enabled manually if needed.
bool disable_default_sink = 5 [(.google.api.field_behavior) = OPTIONAL];
value
- The disableDefaultSink to set.public Settings.Builder clearDisableDefaultSink()
Optional. If set to true, the _Default sink in newly created projects and folders will created in a disabled state. This can be used to automatically disable log ingestion if there is already an aggregated sink configured in the hierarchy. The _Default sink can be re-enabled manually if needed.
bool disable_default_sink = 5 [(.google.api.field_behavior) = OPTIONAL];
public final Settings.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields
in interface com.google.protobuf.Message.Builder
setUnknownFields
in class com.google.protobuf.GeneratedMessageV3.Builder<Settings.Builder>
public final Settings.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields
in interface com.google.protobuf.Message.Builder
mergeUnknownFields
in class com.google.protobuf.GeneratedMessageV3.Builder<Settings.Builder>
Copyright © 2023 Google LLC. All rights reserved.