com.google.logging.v2

Class Settings

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.logging.v2.Settings

All Implemented Interfaces:

SettingsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Settings
extends com.google.protobuf.GeneratedMessageV3
implements SettingsOrBuilder

 Describes the settings associated with a project, folder, organization,
 billing account, or flexible resource.
 

Protobuf type google.logging.v2.Settings

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Settings.Builder Describes the settings associated with a project, folder, organization, billing account, or flexible resource.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DISABLE_DEFAULT_SINK_FIELD_NUMBER
static int	KMS_KEY_NAME_FIELD_NUMBER
static int	KMS_SERVICE_ACCOUNT_ID_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	STORAGE_LOCATION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Settings	getDefaultInstance()
Settings	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<Settings>	getParserForType()
int	getSerializedSize()
String	getStorageLocation() Optional.
com.google.protobuf.ByteString	getStorageLocationBytes() Optional.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Settings.Builder	newBuilder()
static Settings.Builder	newBuilder(Settings prototype)
Settings.Builder	newBuilderForType()
protected Settings.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Settings	parseDelimitedFrom(InputStream input)
static Settings	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Settings	parseFrom(byte[] data)
static Settings	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Settings	parseFrom(ByteBuffer data)
static Settings	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Settings	parseFrom(com.google.protobuf.ByteString data)
static Settings	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Settings	parseFrom(com.google.protobuf.CodedInputStream input)
static Settings	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Settings	parseFrom(InputStream input)
static Settings	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Settings>	parser()
Settings.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

KMS_KEY_NAME_FIELD_NUMBER

public static final int KMS_KEY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

KMS_SERVICE_ACCOUNT_ID_FIELD_NUMBER

public static final int KMS_SERVICE_ACCOUNT_ID_FIELD_NUMBER

See Also:

Constant Field Values

STORAGE_LOCATION_FIELD_NUMBER

public static final int STORAGE_LOCATION_FIELD_NUMBER

See Also:

Constant Field Values

DISABLE_DEFAULT_SINK_FIELD_NUMBER

public static final int DISABLE_DEFAULT_SINK_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

 Output only. The resource name of the settings.
 

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

Specified by:

getName in interface SettingsOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Output only. The resource name of the settings.
 

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

Specified by:

getNameBytes in interface SettingsOrBuilder

Returns:

The bytes for name.

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](https://cloud.google.com/logging/docs/routing/managed-encryption)
 for more information.
 

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

Specified by:

getKmsKeyName in interface SettingsOrBuilder

Returns:

The kmsKeyName.

getKmsKeyNameBytes

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];

Specified by:

getKmsKeyNameBytes in interface SettingsOrBuilder

Returns:

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][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];

Specified by:

getKmsServiceAccountId in interface SettingsOrBuilder

Returns:

The kmsServiceAccountId.

getKmsServiceAccountIdBytes

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];

Specified by:

getKmsServiceAccountIdBytes in interface SettingsOrBuilder

Returns:

The bytes for kmsServiceAccountId.

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];

Specified by:

getStorageLocation in interface SettingsOrBuilder

Returns:

The storageLocation.

getStorageLocationBytes

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];

Specified by:

getStorageLocationBytes in interface SettingsOrBuilder

Returns:

The bytes for storageLocation.

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];

Specified by:

getDisableDefaultSink in interface SettingsOrBuilder

Returns:

The disableDefaultSink.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Settings parseFrom(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Settings parseFrom(ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Settings parseFrom(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Settings parseFrom(com.google.protobuf.ByteString data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Settings parseFrom(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Settings parseFrom(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Settings parseFrom(InputStream input)
                          throws IOException

Throws:

IOException

parseFrom

public static Settings parseFrom(InputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static Settings parseDelimitedFrom(InputStream input)
                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static Settings parseDelimitedFrom(InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:

IOException

parseFrom

public static Settings parseFrom(com.google.protobuf.CodedInputStream input)
                          throws IOException

Throws:

IOException

parseFrom

public static Settings parseFrom(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException

Throws:

IOException

newBuilderForType

public Settings.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Settings.Builder newBuilder()

newBuilder

public static Settings.Builder newBuilder(Settings prototype)

toBuilder

public Settings.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Settings.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Settings getDefaultInstance()

parser

public static com.google.protobuf.Parser<Settings> parser()

getParserForType

public com.google.protobuf.Parser<Settings> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Settings getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder