public final class LogBucket extends com.google.protobuf.GeneratedMessageV3 implements LogBucketOrBuilder
Describes a repository in which log entries are stored.Protobuf type
google.logging.v2.LogBucket
Modifier and Type | Class and Description |
---|---|
static class |
LogBucket.Builder
Describes a repository in which log entries are stored.
|
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
Modifier and Type | Field and Description |
---|---|
static int |
ANALYTICS_ENABLED_FIELD_NUMBER |
static int |
CMEK_SETTINGS_FIELD_NUMBER |
static int |
CREATE_TIME_FIELD_NUMBER |
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
INDEX_CONFIGS_FIELD_NUMBER |
static int |
LIFECYCLE_STATE_FIELD_NUMBER |
static int |
LOCKED_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
RESTRICTED_FIELDS_FIELD_NUMBER |
static int |
RETENTION_DAYS_FIELD_NUMBER |
static int |
UPDATE_TIME_FIELD_NUMBER |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
boolean |
getAnalyticsEnabled()
Whether log analytics is enabled for this bucket.
|
CmekSettings |
getCmekSettings()
The CMEK settings of the log bucket.
|
CmekSettingsOrBuilder |
getCmekSettingsOrBuilder()
The CMEK settings of the log bucket.
|
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
static LogBucket |
getDefaultInstance() |
LogBucket |
getDefaultInstanceForType() |
String |
getDescription()
Describes this bucket.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
Describes this bucket.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
IndexConfig |
getIndexConfigs(int index)
A list of indexed fields and related configuration data.
|
int |
getIndexConfigsCount()
A list of indexed fields and related configuration data.
|
List<IndexConfig> |
getIndexConfigsList()
A list of indexed fields and related configuration data.
|
IndexConfigOrBuilder |
getIndexConfigsOrBuilder(int index)
A list of indexed fields and related configuration data.
|
List<? extends IndexConfigOrBuilder> |
getIndexConfigsOrBuilderList()
A list of indexed fields and related configuration data.
|
LifecycleState |
getLifecycleState()
Output only.
|
int |
getLifecycleStateValue()
Output only.
|
boolean |
getLocked()
Whether the bucket is locked.
|
String |
getName()
Output only.
|
com.google.protobuf.ByteString |
getNameBytes()
Output only.
|
com.google.protobuf.Parser<LogBucket> |
getParserForType() |
String |
getRestrictedFields(int index)
Log entry field paths that are denied access in this bucket.
|
com.google.protobuf.ByteString |
getRestrictedFieldsBytes(int index)
Log entry field paths that are denied access in this bucket.
|
int |
getRestrictedFieldsCount()
Log entry field paths that are denied access in this bucket.
|
com.google.protobuf.ProtocolStringList |
getRestrictedFieldsList()
Log entry field paths that are denied access in this bucket.
|
int |
getRetentionDays()
Logs will be retained by default for this amount of time, after which they
will automatically be deleted.
|
int |
getSerializedSize() |
com.google.protobuf.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateTimeOrBuilder()
Output only.
|
boolean |
hasCmekSettings()
The CMEK settings of the log bucket.
|
boolean |
hasCreateTime()
Output only.
|
int |
hashCode() |
boolean |
hasUpdateTime()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static LogBucket.Builder |
newBuilder() |
static LogBucket.Builder |
newBuilder(LogBucket prototype) |
LogBucket.Builder |
newBuilderForType() |
protected LogBucket.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static LogBucket |
parseDelimitedFrom(InputStream input) |
static LogBucket |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LogBucket |
parseFrom(byte[] data) |
static LogBucket |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LogBucket |
parseFrom(ByteBuffer data) |
static LogBucket |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LogBucket |
parseFrom(com.google.protobuf.ByteString data) |
static LogBucket |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LogBucket |
parseFrom(com.google.protobuf.CodedInputStream input) |
static LogBucket |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LogBucket |
parseFrom(InputStream input) |
static LogBucket |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<LogBucket> |
parser() |
LogBucket.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
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
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int NAME_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
public static final int RETENTION_DAYS_FIELD_NUMBER
public static final int LOCKED_FIELD_NUMBER
public static final int LIFECYCLE_STATE_FIELD_NUMBER
public static final int ANALYTICS_ENABLED_FIELD_NUMBER
public static final int RESTRICTED_FIELDS_FIELD_NUMBER
public static final int INDEX_CONFIGS_FIELD_NUMBER
public static final int CMEK_SETTINGS_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class com.google.protobuf.GeneratedMessageV3
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
public String getName()
Output only. The resource name of the bucket. For example: `projects/my-project/locations/global/buckets/my-bucket` For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support) For the location of `global` it is unspecified where log entries are actually stored. After a bucket has been created, the location cannot be changed.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
getName
in interface LogBucketOrBuilder
public com.google.protobuf.ByteString getNameBytes()
Output only. The resource name of the bucket. For example: `projects/my-project/locations/global/buckets/my-bucket` For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support) For the location of `global` it is unspecified where log entries are actually stored. After a bucket has been created, the location cannot be changed.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
getNameBytes
in interface LogBucketOrBuilder
public String getDescription()
Describes this bucket.
string description = 3;
getDescription
in interface LogBucketOrBuilder
public com.google.protobuf.ByteString getDescriptionBytes()
Describes this bucket.
string description = 3;
getDescriptionBytes
in interface LogBucketOrBuilder
public boolean hasCreateTime()
Output only. The creation timestamp of the bucket. This is not set for any of the default buckets.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime
in interface LogBucketOrBuilder
public com.google.protobuf.Timestamp getCreateTime()
Output only. The creation timestamp of the bucket. This is not set for any of the default buckets.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime
in interface LogBucketOrBuilder
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The creation timestamp of the bucket. This is not set for any of the default buckets.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder
in interface LogBucketOrBuilder
public boolean hasUpdateTime()
Output only. The last update timestamp of the bucket.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasUpdateTime
in interface LogBucketOrBuilder
public com.google.protobuf.Timestamp getUpdateTime()
Output only. The last update timestamp of the bucket.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTime
in interface LogBucketOrBuilder
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The last update timestamp of the bucket.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder
in interface LogBucketOrBuilder
public int getRetentionDays()
Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used.
int32 retention_days = 11;
getRetentionDays
in interface LogBucketOrBuilder
public boolean getLocked()
Whether the bucket is locked. The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty.
bool locked = 9;
getLocked
in interface LogBucketOrBuilder
public int getLifecycleStateValue()
Output only. The bucket lifecycle state.
.google.logging.v2.LifecycleState lifecycle_state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getLifecycleStateValue
in interface LogBucketOrBuilder
public LifecycleState getLifecycleState()
Output only. The bucket lifecycle state.
.google.logging.v2.LifecycleState lifecycle_state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getLifecycleState
in interface LogBucketOrBuilder
public boolean getAnalyticsEnabled()
Whether log analytics is enabled for this bucket. Once enabled, log analytics features cannot be disabled.
bool analytics_enabled = 14;
getAnalyticsEnabled
in interface LogBucketOrBuilder
public com.google.protobuf.ProtocolStringList getRestrictedFieldsList()
Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: `textPayload`, `jsonPayload`, `protoPayload`, `httpRequest`, `labels`, `sourceLocation`. Restricting a repeated field will restrict all values. Adding a parent will block all child fields. (e.g. `foo.bar` will block `foo.bar.baz`)
repeated string restricted_fields = 15;
getRestrictedFieldsList
in interface LogBucketOrBuilder
public int getRestrictedFieldsCount()
Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: `textPayload`, `jsonPayload`, `protoPayload`, `httpRequest`, `labels`, `sourceLocation`. Restricting a repeated field will restrict all values. Adding a parent will block all child fields. (e.g. `foo.bar` will block `foo.bar.baz`)
repeated string restricted_fields = 15;
getRestrictedFieldsCount
in interface LogBucketOrBuilder
public String getRestrictedFields(int index)
Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: `textPayload`, `jsonPayload`, `protoPayload`, `httpRequest`, `labels`, `sourceLocation`. Restricting a repeated field will restrict all values. Adding a parent will block all child fields. (e.g. `foo.bar` will block `foo.bar.baz`)
repeated string restricted_fields = 15;
getRestrictedFields
in interface LogBucketOrBuilder
index
- The index of the element to return.public com.google.protobuf.ByteString getRestrictedFieldsBytes(int index)
Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: `textPayload`, `jsonPayload`, `protoPayload`, `httpRequest`, `labels`, `sourceLocation`. Restricting a repeated field will restrict all values. Adding a parent will block all child fields. (e.g. `foo.bar` will block `foo.bar.baz`)
repeated string restricted_fields = 15;
getRestrictedFieldsBytes
in interface LogBucketOrBuilder
index
- The index of the value to return.public List<IndexConfig> getIndexConfigsList()
A list of indexed fields and related configuration data.
repeated .google.logging.v2.IndexConfig index_configs = 17;
getIndexConfigsList
in interface LogBucketOrBuilder
public List<? extends IndexConfigOrBuilder> getIndexConfigsOrBuilderList()
A list of indexed fields and related configuration data.
repeated .google.logging.v2.IndexConfig index_configs = 17;
getIndexConfigsOrBuilderList
in interface LogBucketOrBuilder
public int getIndexConfigsCount()
A list of indexed fields and related configuration data.
repeated .google.logging.v2.IndexConfig index_configs = 17;
getIndexConfigsCount
in interface LogBucketOrBuilder
public IndexConfig getIndexConfigs(int index)
A list of indexed fields and related configuration data.
repeated .google.logging.v2.IndexConfig index_configs = 17;
getIndexConfigs
in interface LogBucketOrBuilder
public IndexConfigOrBuilder getIndexConfigsOrBuilder(int index)
A list of indexed fields and related configuration data.
repeated .google.logging.v2.IndexConfig index_configs = 17;
getIndexConfigsOrBuilder
in interface LogBucketOrBuilder
public boolean hasCmekSettings()
The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed.
.google.logging.v2.CmekSettings cmek_settings = 19;
hasCmekSettings
in interface LogBucketOrBuilder
public CmekSettings getCmekSettings()
The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed.
.google.logging.v2.CmekSettings cmek_settings = 19;
getCmekSettings
in interface LogBucketOrBuilder
public CmekSettingsOrBuilder getCmekSettingsOrBuilder()
The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed.
.google.logging.v2.CmekSettings cmek_settings = 19;
getCmekSettingsOrBuilder
in interface LogBucketOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static LogBucket parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LogBucket parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LogBucket parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LogBucket parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LogBucket parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LogBucket parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LogBucket parseFrom(InputStream input) throws IOException
IOException
public static LogBucket parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static LogBucket parseDelimitedFrom(InputStream input) throws IOException
IOException
public static LogBucket parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static LogBucket parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOException
public static LogBucket parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public LogBucket.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static LogBucket.Builder newBuilder()
public static LogBucket.Builder newBuilder(LogBucket prototype)
public LogBucket.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected LogBucket.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static LogBucket getDefaultInstance()
public static com.google.protobuf.Parser<LogBucket> parser()
public com.google.protobuf.Parser<LogBucket> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public LogBucket getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
Copyright © 2023 Google LLC. All rights reserved.