public interface LogBucketOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAnalyticsEnabled()
public abstract 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 abstract 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;
| Returns | |
|---|---|
| Type | Description |
CmekSettings | The cmekSettings. |
getCmekSettingsOrBuilder()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
CmekSettingsOrBuilder | |
getCreateTime()
public abstract 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 abstract 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];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getDescription()
public abstract String getDescription()Describes this bucket.
string description = 3;
| Returns | |
|---|---|
| Type | Description |
String | The description. |
getDescriptionBytes()
public abstract ByteString getDescriptionBytes()Describes this bucket.
string description = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for description. |
getIndexConfigs(int index)
public abstract 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 |
| Returns | |
|---|---|
| Type | Description |
IndexConfig | |
getIndexConfigsCount()
public abstract 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 abstract List<IndexConfig> getIndexConfigsList()A list of indexed fields and related configuration data.
repeated .google.logging.v2.IndexConfig index_configs = 17;
| Returns | |
|---|---|
| Type | Description |
List<IndexConfig> | |
getIndexConfigsOrBuilder(int index)
public abstract 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 |
| Returns | |
|---|---|
| Type | Description |
IndexConfigOrBuilder | |
getIndexConfigsOrBuilderList()
public abstract 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 abstract LifecycleState getLifecycleState()Output only. The bucket lifecycle state.
.google.logging.v2.LifecycleState lifecycle_state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
LifecycleState | The lifecycleState. |
getLifecycleStateValue()
public abstract 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 abstract 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()
public abstract 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
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 abstract 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. |
getRestrictedFields(int index)
public abstract 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 | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The restrictedFields at the given index. |
getRestrictedFieldsBytes(int index)
public abstract 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 | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the restrictedFields at the given index. |
getRestrictedFieldsCount()
public abstract 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 abstract List<String> 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;
| Returns | |
|---|---|
| Type | Description |
List<String> | A list containing the restrictedFields. |
getRetentionDays()
public abstract 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. |
getUpdateTime()
public abstract 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 abstract TimestampOrBuilder getUpdateTimeOrBuilder()Output only. The last update timestamp of the bucket.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
hasCmekSettings()
public abstract 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 abstract 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 abstract 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. |