Package com.google.logging.v2

Class LogExclusion

  • All Implemented Interfaces:
    LogExclusionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class LogExclusion
extends com.google.protobuf.GeneratedMessageV3
implements LogExclusionOrBuilder
     Specifies a set of log entries that are filtered out by a sink. If
 your Google Cloud resource receives a large volume of log entries, you can
 use exclusions to reduce your chargeable logs. Note that exclusions on
 organization-level and folder-level sinks don't apply to child resources.
 Note also that you cannot modify the _Required sink or exclude logs from it.
    Protobuf type google.logging.v2.LogExclusion
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  LogExclusion.Builder
      Specifies a set of log entries that are filtered out by a sink.

      • 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

    • 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()
         Required. A client-assigned identifier, such as
 `"load-balancer-exclusion"`. Identifiers are limited to 100 characters and
 can include only letters, digits, underscores, hyphens, and periods. First
 character has to be alphanumeric.
        string name = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getName in interface LogExclusionOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Required. A client-assigned identifier, such as
 `"load-balancer-exclusion"`. Identifiers are limited to 100 characters and
 can include only letters, digits, underscores, hyphens, and periods. First
 character has to be alphanumeric.
        string name = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getNameBytes in interface LogExclusionOrBuilder
        Returns:
        The bytes for name.

      • getDescription

        public String getDescription()
         Optional. A description of this exclusion.
        string description = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDescription in interface LogExclusionOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Optional. A description of this exclusion.
        string description = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDescriptionBytes in interface LogExclusionOrBuilder
        Returns:
        The bytes for description.

      • getFilter

        public String getFilter()
         Required. An [advanced logs
 filter](https://cloud.google.com/logging/docs/view/advanced-queries) that
 matches the log entries to be excluded. By using the [sample
 function](https://cloud.google.com/logging/docs/view/advanced-queries#sample),
 you can exclude less than 100% of the matching log entries.

 For example, the following query matches 99% of low-severity log entries
 from Google Cloud Storage buckets:

   `resource.type=gcs_bucket severity<ERROR sample(insertId, 0.99)`
        string filter = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFilter in interface LogExclusionOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         Required. An [advanced logs
 filter](https://cloud.google.com/logging/docs/view/advanced-queries) that
 matches the log entries to be excluded. By using the [sample
 function](https://cloud.google.com/logging/docs/view/advanced-queries#sample),
 you can exclude less than 100% of the matching log entries.

 For example, the following query matches 99% of low-severity log entries
 from Google Cloud Storage buckets:

   `resource.type=gcs_bucket severity<ERROR sample(insertId, 0.99)`
        string filter = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFilterBytes in interface LogExclusionOrBuilder
        Returns:
        The bytes for filter.

      • getDisabled

        public boolean getDisabled()
         Optional. If set to True, then this exclusion is disabled and it does not
 exclude any log entries. You can [update an
 exclusion][google.logging.v2.ConfigServiceV2.UpdateExclusion] to change the
 value of this field.
        bool disabled = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDisabled in interface LogExclusionOrBuilder
        Returns:
        The disabled.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The creation timestamp of the exclusion.

 This field may not be present for older exclusions.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface LogExclusionOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The creation timestamp of the exclusion.

 This field may not be present for older exclusions.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface LogExclusionOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The creation timestamp of the exclusion.

 This field may not be present for older exclusions.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface LogExclusionOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. The last update timestamp of the exclusion.

 This field may not be present for older exclusions.
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface LogExclusionOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. The last update timestamp of the exclusion.

 This field may not be present for older exclusions.
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface LogExclusionOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The last update timestamp of the exclusion.

 This field may not be present for older exclusions.
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface LogExclusionOrBuilder

      • 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 LogExclusion parseFrom​(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LogExclusion parseFrom​(ByteBuffer data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LogExclusion parseFrom​(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LogExclusion parseFrom​(com.google.protobuf.ByteString data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LogExclusion parseFrom​(byte[] data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LogExclusion parseFrom​(byte[] data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LogExclusion parseFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException
        Throws:
        IOException

      • newBuilderForType

        public LogExclusion.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public LogExclusion.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected LogExclusion.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static LogExclusion getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<LogExclusion> 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 LogExclusion getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder