public final class Settings extends GeneratedMessageV3 implements SettingsOrBuilder
Describes the settings associated with a project, folder, organization,
billing account, or flexible resource.
Protobuf type google.logging.v2.Settings
Static Fields
DISABLE_DEFAULT_SINK_FIELD_NUMBER
public static final int DISABLE_DEFAULT_SINK_FIELD_NUMBER
Field Value
KMS_KEY_NAME_FIELD_NUMBER
public static final int KMS_KEY_NAME_FIELD_NUMBER
Field Value
KMS_SERVICE_ACCOUNT_ID_FIELD_NUMBER
public static final int KMS_SERVICE_ACCOUNT_ID_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
STORAGE_LOCATION_FIELD_NUMBER
public static final int STORAGE_LOCATION_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Settings getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Settings.Builder newBuilder()
Returns
newBuilder(Settings prototype)
public static Settings.Builder newBuilder(Settings prototype)
Parameter
Returns
public static Settings parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Settings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Settings parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Settings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Settings parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Settings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Settings parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Settings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Settings parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Settings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Settings parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Settings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Settings> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public Settings getDefaultInstanceForType()
Returns
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];
| 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];
| 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];
| 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];
| 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];
| Type | Description |
| ByteString | The bytes for kmsServiceAccountId.
|
getName()
Output only. The resource name of the settings.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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];
getParserForType()
public Parser<Settings> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
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];
| 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];
| Type | Description |
| ByteString | The bytes for storageLocation.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Settings.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Settings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Settings.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
