public static final class Settings.Builder extends GeneratedMessageV3.Builder<Settings.Builder> implements SettingsOrBuilderDescribes the settings associated with a project, folder, organization, billing account, or flexible resource.
Protobuf type google.logging.v2.Settings
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Settings.BuilderImplements
SettingsOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Settings.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Settings.Builder | |
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 | |
clearDisableDefaultSink()
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];
| Returns | |
|---|---|
| Type | Description |
Settings.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Settings.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Settings.Builder | |
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"
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
for more information.
string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Settings.Builder | This builder for chaining. |
clearKmsServiceAccountId()
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 to
obtain the service account ID.
See Enabling CMEK for Log
Router
for more information.
string kms_service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Settings.Builder | This builder for chaining. |
clearName()
public Settings.Builder clearName()Output only. The resource name of the settings.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Settings.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Settings.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Settings.Builder | |
clearStorageLocation()
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];
| Returns | |
|---|---|
| Type | Description |
Settings.Builder | This builder for chaining. |
clone()
public Settings.Builder clone()| Returns | |
|---|---|
| Type | Description |
Settings.Builder | |
getDefaultInstanceForType()
public Settings getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Settings | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getDisableDefaultSink()
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];
| Returns | |
|---|---|
| Type | Description |
boolean | The disableDefaultSink. |
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"
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
for more information.
string kms_key_name = 2 [(.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"
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
for more information.
string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for kmsKeyName. |
getKmsServiceAccountId()
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 to
obtain the service account ID.
See Enabling CMEK for Log
Router
for more information.
string kms_service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String | The kmsServiceAccountId. |
getKmsServiceAccountIdBytes()
public 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 to
obtain the service account ID.
See Enabling CMEK for Log
Router
for more information.
string kms_service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for kmsServiceAccountId. |
getName()
public String getName()Output only. The resource name of the settings.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String | The name. |
getNameBytes()
public ByteString getNameBytes()Output only. The resource name of the settings.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for name. |
getStorageLocation()
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];
| Returns | |
|---|---|
| Type | Description |
String | The storageLocation. |
getStorageLocationBytes()
public 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];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for storageLocation. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
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 | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Settings.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Settings.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Settings.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Settings.Builder | |
setDisableDefaultSink(boolean value)
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];
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe disableDefaultSink to set. |
| Returns | |
|---|---|
| Type | Description |
Settings.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Settings.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Settings.Builder | |
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"
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
for more information.
string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe 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"
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
for more information.
string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for kmsKeyName to set. |
| Returns | |
|---|---|
| Type | Description |
Settings.Builder | This builder for chaining. |
setKmsServiceAccountId(String value)
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 to
obtain the service account ID.
See Enabling CMEK for Log
Router
for more information.
string kms_service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe kmsServiceAccountId to set. |
| Returns | |
|---|---|
| Type | Description |
Settings.Builder | This builder for chaining. |
setKmsServiceAccountIdBytes(ByteString value)
public Settings.Builder setKmsServiceAccountIdBytes(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 to
obtain the service account ID.
See Enabling CMEK for Log
Router
for more information.
string kms_service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for kmsServiceAccountId to set. |
| Returns | |
|---|---|
| Type | Description |
Settings.Builder | This builder for chaining. |
setName(String value)
public Settings.Builder setName(String value)Output only. The resource name of the settings.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Settings.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public Settings.Builder setNameBytes(ByteString value)Output only. The resource name of the settings.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Settings.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Settings.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Settings.Builder | |
setStorageLocation(String value)
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];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe storageLocation to set. |
| Returns | |
|---|---|
| Type | Description |
Settings.Builder | This builder for chaining. |
setStorageLocationBytes(ByteString value)
public Settings.Builder setStorageLocationBytes(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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for storageLocation to set. |
| Returns | |
|---|---|
| Type | Description |
Settings.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Settings.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Settings.Builder | |