Package com.google.cloud.securitycenter.v1

Class MuteConfig

  • All Implemented Interfaces:
    MuteConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class MuteConfig
extends com.google.protobuf.GeneratedMessageV3
implements MuteConfigOrBuilder
     A mute config is a Cloud SCC resource that contains the configuration
 to mute create/update events of findings.
    Protobuf type google.cloud.securitycenter.v1.MuteConfig
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  MuteConfig.Builder
      A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.

      • 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()
         This field will be ignored if provided on config creation. Format
 "organizations/{organization}/muteConfigs/{mute_config}"
 "folders/{folder}/muteConfigs/{mute_config}"
 "projects/{project}/muteConfigs/{mute_config}"
        string name = 1;
        Specified by:
        getName in interface MuteConfigOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         This field will be ignored if provided on config creation. Format
 "organizations/{organization}/muteConfigs/{mute_config}"
 "folders/{folder}/muteConfigs/{mute_config}"
 "projects/{project}/muteConfigs/{mute_config}"
        string name = 1;
        Specified by:
        getNameBytes in interface MuteConfigOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        @Deprecated
public String getDisplayName()
        Deprecated.
        google.cloud.securitycenter.v1.MuteConfig.display_name is deprecated. See google/cloud/securitycenter/v1/mute_config.proto;l=47
         The human readable name to be displayed for the mute config.
        string display_name = 2 [deprecated = true];
        Specified by:
        getDisplayName in interface MuteConfigOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        @Deprecated
public com.google.protobuf.ByteString getDisplayNameBytes()
        Deprecated.
        google.cloud.securitycenter.v1.MuteConfig.display_name is deprecated. See google/cloud/securitycenter/v1/mute_config.proto;l=47
         The human readable name to be displayed for the mute config.
        string display_name = 2 [deprecated = true];
        Specified by:
        getDisplayNameBytes in interface MuteConfigOrBuilder
        Returns:
        The bytes for displayName.

      • getDescription

        public String getDescription()
         A description of the mute config.
        string description = 3;
        Specified by:
        getDescription in interface MuteConfigOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         A description of the mute config.
        string description = 3;
        Specified by:
        getDescriptionBytes in interface MuteConfigOrBuilder
        Returns:
        The bytes for description.

      • getFilter

        public String getFilter()
         Required. An expression that defines the filter to apply across
 create/update events of findings. While creating a filter string, be
 mindful of the scope in which the mute configuration is being created.
 E.g., If a filter contains project = X but is created under the project = Y
 scope, it might not match any findings.

 The following field and operator combinations are supported:

 * severity: `=`, `:`
 * category: `=`, `:`
 * resource.name: `=`, `:`
 * resource.project_name: `=`, `:`
 * resource.project_display_name: `=`, `:`
 * resource.folders.resource_folder: `=`, `:`
 * resource.parent_name: `=`, `:`
 * resource.parent_display_name: `=`, `:`
 * resource.type: `=`, `:`
 * finding_class: `=`, `:`
 * indicator.ip_addresses: `=`, `:`
 * indicator.domains: `=`, `:`
        string filter = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFilter in interface MuteConfigOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         Required. An expression that defines the filter to apply across
 create/update events of findings. While creating a filter string, be
 mindful of the scope in which the mute configuration is being created.
 E.g., If a filter contains project = X but is created under the project = Y
 scope, it might not match any findings.

 The following field and operator combinations are supported:

 * severity: `=`, `:`
 * category: `=`, `:`
 * resource.name: `=`, `:`
 * resource.project_name: `=`, `:`
 * resource.project_display_name: `=`, `:`
 * resource.folders.resource_folder: `=`, `:`
 * resource.parent_name: `=`, `:`
 * resource.parent_display_name: `=`, `:`
 * resource.type: `=`, `:`
 * finding_class: `=`, `:`
 * indicator.ip_addresses: `=`, `:`
 * indicator.domains: `=`, `:`
        string filter = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFilterBytes in interface MuteConfigOrBuilder
        Returns:
        The bytes for filter.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The time at which the mute config was created.
 This field is set by the server and will be ignored if provided on config
 creation.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface MuteConfigOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The time at which the mute config was created.
 This field is set by the server and will be ignored if provided on config
 creation.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface MuteConfigOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time at which the mute config was created.
 This field is set by the server and will be ignored if provided on config
 creation.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface MuteConfigOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. The most recent time at which the mute config was updated.
 This field is set by the server and will be ignored if provided on config
 creation or update.
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface MuteConfigOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. The most recent time at which the mute config was updated.
 This field is set by the server and will be ignored if provided on config
 creation or update.
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface MuteConfigOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The most recent time at which the mute config was updated.
 This field is set by the server and will be ignored if provided on config
 creation or update.
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface MuteConfigOrBuilder

      • getMostRecentEditor

        public String getMostRecentEditor()
         Output only. Email address of the user who last edited the mute config.
 This field is set by the server and will be ignored if provided on config
 creation or update.
        string most_recent_editor = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMostRecentEditor in interface MuteConfigOrBuilder
        Returns:
        The mostRecentEditor.

      • getMostRecentEditorBytes

        public com.google.protobuf.ByteString getMostRecentEditorBytes()
         Output only. Email address of the user who last edited the mute config.
 This field is set by the server and will be ignored if provided on config
 creation or update.
        string most_recent_editor = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMostRecentEditorBytes in interface MuteConfigOrBuilder
        Returns:
        The bytes for mostRecentEditor.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static MuteConfig getDefaultInstance()

      • parser

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

      • getParserForType

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