public final class LogBucket extends GeneratedMessageV3 implements LogBucketOrBuilder
Describes a repository in which log entries are stored.
Protobuf type google.logging.v2.LogBucket
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
ANALYTICS_ENABLED_FIELD_NUMBER
public static final int ANALYTICS_ENABLED_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CMEK_SETTINGS_FIELD_NUMBER
public static final int CMEK_SETTINGS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
INDEX_CONFIGS_FIELD_NUMBER
public static final int INDEX_CONFIGS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LIFECYCLE_STATE_FIELD_NUMBER
public static final int LIFECYCLE_STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LOCKED_FIELD_NUMBER
public static final int LOCKED_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RESTRICTED_FIELDS_FIELD_NUMBER
public static final int RESTRICTED_FIELDS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RETENTION_DAYS_FIELD_NUMBER
public static final int RETENTION_DAYS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static LogBucket getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static LogBucket.Builder newBuilder()
newBuilder(LogBucket prototype)
public static LogBucket.Builder newBuilder(LogBucket prototype)
public static LogBucket parseDelimitedFrom(InputStream input)
public static LogBucket parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static LogBucket parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static LogBucket parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static LogBucket parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static LogBucket parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static LogBucket parseFrom(CodedInputStream input)
public static LogBucket parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static LogBucket parseFrom(InputStream input)
public static LogBucket parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static LogBucket parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static LogBucket parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<LogBucket> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAnalyticsEnabled()
public boolean getAnalyticsEnabled()
Whether log analytics is enabled for this bucket.
Once enabled, log analytics features cannot be disabled.
bool analytics_enabled = 14;
| Returns |
|---|
| Type | Description |
boolean | The analyticsEnabled.
|
getCmekSettings()
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;
getCmekSettingsOrBuilder()
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;
getCreateTime()
public 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];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
getCreateTimeOrBuilder()
public 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];
getDefaultInstanceForType()
public LogBucket getDefaultInstanceForType()
getDescription()
public String getDescription()
Describes this bucket.
string description = 3;
| Returns |
|---|
| Type | Description |
String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Describes this bucket.
string description = 3;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for description.
|
getIndexConfigs(int index)
public IndexConfig getIndexConfigs(int index)
A list of indexed fields and related configuration data.
repeated .google.logging.v2.IndexConfig index_configs = 17;
| Parameter |
|---|
| Name | Description |
index | int
|
getIndexConfigsCount()
public int getIndexConfigsCount()
A list of indexed fields and related configuration data.
repeated .google.logging.v2.IndexConfig index_configs = 17;
| Returns |
|---|
| Type | Description |
int | |
getIndexConfigsList()
public List<IndexConfig> getIndexConfigsList()
A list of indexed fields and related configuration data.
repeated .google.logging.v2.IndexConfig index_configs = 17;
getIndexConfigsOrBuilder(int index)
public IndexConfigOrBuilder getIndexConfigsOrBuilder(int index)
A list of indexed fields and related configuration data.
repeated .google.logging.v2.IndexConfig index_configs = 17;
| Parameter |
|---|
| Name | Description |
index | int
|
getIndexConfigsOrBuilderList()
public List<? extends IndexConfigOrBuilder> getIndexConfigsOrBuilderList()
A list of indexed fields and related configuration data.
repeated .google.logging.v2.IndexConfig index_configs = 17;
| Returns |
|---|
| Type | Description |
List<? extends com.google.logging.v2.IndexConfigOrBuilder> | |
getLifecycleState()
public LifecycleState getLifecycleState()
Output only. The bucket lifecycle state.
.google.logging.v2.LifecycleState lifecycle_state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getLifecycleStateValue()
public int getLifecycleStateValue()
Output only. The bucket lifecycle state.
.google.logging.v2.LifecycleState lifecycle_state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for lifecycleState.
|
getLocked()
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;
| Returns |
|---|
| Type | Description |
boolean | The locked.
|
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
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];
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public 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
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];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<LogBucket> getParserForType()
Overrides
getRestrictedFields(int index)
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;
| Parameter |
|---|
| Name | Description |
index | int
The index of the element to return.
|
| Returns |
|---|
| Type | Description |
String | The restrictedFields at the given index.
|
getRestrictedFieldsBytes(int index)
public 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;
| Parameter |
|---|
| Name | Description |
index | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
ByteString | The bytes of the restrictedFields at the given index.
|
getRestrictedFieldsCount()
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;
| Returns |
|---|
| Type | Description |
int | The count of restrictedFields.
|
getRestrictedFieldsList()
public 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;
getRetentionDays()
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;
| Returns |
|---|
| Type | Description |
int | The retentionDays.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The last update timestamp of the bucket.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The last update timestamp of the bucket.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCmekSettings()
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;
| Returns |
|---|
| Type | Description |
boolean | Whether the cmekSettings field is set.
|
hasCreateTime()
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];
| Returns |
|---|
| Type | Description |
boolean | Whether the createTime field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. The last update timestamp of the bucket.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public LogBucket.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected LogBucket.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public LogBucket.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
