public static final class LogBucket.Builder extends GeneratedMessageV3.Builder<LogBucket.Builder> implements LogBucketOrBuilderDescribes a repository in which log entries are stored.
Protobuf type google.logging.v2.LogBucket
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > LogBucket.BuilderImplements
LogBucketOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addAllRestrictedFields(Iterable<String> values)
public LogBucket.Builder addAllRestrictedFields(Iterable<String> values) 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;
| Name | Description |
| values | Iterable<String>The restrictedFields to add. |
| Type | Description |
| LogBucket.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public LogBucket.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| LogBucket.Builder |
addRestrictedFields(String value)
public LogBucket.Builder addRestrictedFields(String value) 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;
| Name | Description |
| value | StringThe restrictedFields to add. |
| Type | Description |
| LogBucket.Builder | This builder for chaining. |
addRestrictedFieldsBytes(ByteString value)
public LogBucket.Builder addRestrictedFieldsBytes(ByteString value) 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;
| Name | Description |
| value | ByteStringThe bytes of the restrictedFields to add. |
| Type | Description |
| LogBucket.Builder | This builder for chaining. |
build()
public LogBucket build()| Type | Description |
| LogBucket |
buildPartial()
public LogBucket buildPartial()| Type | Description |
| LogBucket |
clear()
public LogBucket.Builder clear()| Type | Description |
| LogBucket.Builder |
clearCmekSettings()
public LogBucket.Builder clearCmekSettings()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;
| Type | Description |
| LogBucket.Builder |
clearCreateTime()
public LogBucket.Builder clearCreateTime()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];
| Type | Description |
| LogBucket.Builder |
clearDescription()
public LogBucket.Builder clearDescription()Describes this bucket.
string description = 3;
| Type | Description |
| LogBucket.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public LogBucket.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| LogBucket.Builder |
clearLifecycleState()
public LogBucket.Builder clearLifecycleState()Output only. The bucket lifecycle state.
.google.logging.v2.LifecycleState lifecycle_state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| LogBucket.Builder | This builder for chaining. |
clearLocked()
public LogBucket.Builder clearLocked()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;
| Type | Description |
| LogBucket.Builder | This builder for chaining. |
clearName()
public LogBucket.Builder clearName() 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];
| Type | Description |
| LogBucket.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public LogBucket.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| LogBucket.Builder |
clearRestrictedFields()
public LogBucket.Builder clearRestrictedFields() 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;
| Type | Description |
| LogBucket.Builder | This builder for chaining. |
clearRetentionDays()
public LogBucket.Builder clearRetentionDays()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;
| Type | Description |
| LogBucket.Builder | This builder for chaining. |
clearUpdateTime()
public LogBucket.Builder clearUpdateTime()Output only. The last update timestamp of the bucket.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| LogBucket.Builder |
clone()
public LogBucket.Builder clone()| Type | Description |
| LogBucket.Builder |
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;
| Type | Description |
| CmekSettings | The cmekSettings. |
getCmekSettingsBuilder()
public CmekSettings.Builder getCmekSettingsBuilder()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;
| Type | Description |
| CmekSettings.Builder |
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;
| Type | Description |
| CmekSettingsOrBuilder |
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];
| Type | Description |
| Timestamp | The createTime. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()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];
| Type | Description |
| Builder |
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];
| Type | Description |
| TimestampOrBuilder |
getDefaultInstanceForType()
public LogBucket getDefaultInstanceForType()| Type | Description |
| LogBucket |
getDescription()
public String getDescription()Describes this bucket.
string description = 3;
| Type | Description |
| String | The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()Describes this bucket.
string description = 3;
| Type | Description |
| ByteString | The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
getLifecycleState()
public LifecycleState getLifecycleState()Output only. The bucket lifecycle state.
.google.logging.v2.LifecycleState lifecycle_state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| LifecycleState | The lifecycleState. |
getLifecycleStateValue()
public int getLifecycleStateValue()Output only. The bucket lifecycle state.
.google.logging.v2.LifecycleState lifecycle_state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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;
| Type | Description |
| boolean | The locked. |
getName()
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
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];
| 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];
| Type | Description |
| ByteString | The bytes for name. |
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;
| Name | Description |
| index | intThe index of the element to return. |
| 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;
| Name | Description |
| index | intThe index of the value to return. |
| 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;
| 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;
| Type | Description |
| ProtocolStringList | A list containing the restrictedFields. |
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;
| Type | Description |
| int | The retentionDays. |
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];
| Type | Description |
| Timestamp | The updateTime. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()Output only. The last update timestamp of the bucket.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| Builder |
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];
| Type | Description |
| TimestampOrBuilder |
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;
| 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];
| 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];
| Type | Description |
| boolean | Whether the updateTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeCmekSettings(CmekSettings value)
public LogBucket.Builder mergeCmekSettings(CmekSettings value)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;
| Name | Description |
| value | CmekSettings |
| Type | Description |
| LogBucket.Builder |
mergeCreateTime(Timestamp value)
public LogBucket.Builder mergeCreateTime(Timestamp value)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];
| Name | Description |
| value | Timestamp |
| Type | Description |
| LogBucket.Builder |
mergeFrom(LogBucket other)
public LogBucket.Builder mergeFrom(LogBucket other)| Name | Description |
| other | LogBucket |
| Type | Description |
| LogBucket.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public LogBucket.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| LogBucket.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public LogBucket.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| LogBucket.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final LogBucket.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| LogBucket.Builder |
mergeUpdateTime(Timestamp value)
public LogBucket.Builder mergeUpdateTime(Timestamp value)Output only. The last update timestamp of the bucket.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| value | Timestamp |
| Type | Description |
| LogBucket.Builder |
setCmekSettings(CmekSettings value)
public LogBucket.Builder setCmekSettings(CmekSettings value)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;
| Name | Description |
| value | CmekSettings |
| Type | Description |
| LogBucket.Builder |
setCmekSettings(CmekSettings.Builder builderForValue)
public LogBucket.Builder setCmekSettings(CmekSettings.Builder builderForValue)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;
| Name | Description |
| builderForValue | CmekSettings.Builder |
| Type | Description |
| LogBucket.Builder |
setCreateTime(Timestamp value)
public LogBucket.Builder setCreateTime(Timestamp value)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];
| Name | Description |
| value | Timestamp |
| Type | Description |
| LogBucket.Builder |
setCreateTime(Timestamp.Builder builderForValue)
public LogBucket.Builder setCreateTime(Timestamp.Builder builderForValue)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];
| Name | Description |
| builderForValue | Builder |
| Type | Description |
| LogBucket.Builder |
setDescription(String value)
public LogBucket.Builder setDescription(String value)Describes this bucket.
string description = 3;
| Name | Description |
| value | StringThe description to set. |
| Type | Description |
| LogBucket.Builder | This builder for chaining. |
setDescriptionBytes(ByteString value)
public LogBucket.Builder setDescriptionBytes(ByteString value)Describes this bucket.
string description = 3;
| Name | Description |
| value | ByteStringThe bytes for description to set. |
| Type | Description |
| LogBucket.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public LogBucket.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| LogBucket.Builder |
setLifecycleState(LifecycleState value)
public LogBucket.Builder setLifecycleState(LifecycleState value)Output only. The bucket lifecycle state.
.google.logging.v2.LifecycleState lifecycle_state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| value | LifecycleStateThe lifecycleState to set. |
| Type | Description |
| LogBucket.Builder | This builder for chaining. |
setLifecycleStateValue(int value)
public LogBucket.Builder setLifecycleStateValue(int value)Output only. The bucket lifecycle state.
.google.logging.v2.LifecycleState lifecycle_state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| value | intThe enum numeric value on the wire for lifecycleState to set. |
| Type | Description |
| LogBucket.Builder | This builder for chaining. |
setLocked(boolean value)
public LogBucket.Builder setLocked(boolean value)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;
| Name | Description |
| value | booleanThe locked to set. |
| Type | Description |
| LogBucket.Builder | This builder for chaining. |
setName(String value)
public LogBucket.Builder setName(String value) 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];
| Name | Description |
| value | StringThe name to set. |
| Type | Description |
| LogBucket.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public LogBucket.Builder setNameBytes(ByteString value) 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];
| Name | Description |
| value | ByteStringThe bytes for name to set. |
| Type | Description |
| LogBucket.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public LogBucket.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| LogBucket.Builder |
setRestrictedFields(int index, String value)
public LogBucket.Builder setRestrictedFields(int index, String value) 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;
| Name | Description |
| index | intThe index to set the value at. |
| value | StringThe restrictedFields to set. |
| Type | Description |
| LogBucket.Builder | This builder for chaining. |
setRetentionDays(int value)
public LogBucket.Builder setRetentionDays(int value)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;
| Name | Description |
| value | intThe retentionDays to set. |
| Type | Description |
| LogBucket.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final LogBucket.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| LogBucket.Builder |
setUpdateTime(Timestamp value)
public LogBucket.Builder setUpdateTime(Timestamp value)Output only. The last update timestamp of the bucket.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| value | Timestamp |
| Type | Description |
| LogBucket.Builder |
setUpdateTime(Timestamp.Builder builderForValue)
public LogBucket.Builder setUpdateTime(Timestamp.Builder builderForValue)Output only. The last update timestamp of the bucket.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| builderForValue | Builder |
| Type | Description |
| LogBucket.Builder |