Class MuteConfig (2.52.0)

public final class MuteConfig extends 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.v2.MuteConfig

Implements

MuteConfigOrBuilder

Static Fields

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

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

MOST_RECENT_EDITOR_FIELD_NUMBER

public static final int MOST_RECENT_EDITOR_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_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 MuteConfig getDefaultInstance()
Returns
Type Description
MuteConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static MuteConfig.Builder newBuilder()
Returns
Type Description
MuteConfig.Builder

newBuilder(MuteConfig prototype)

public static MuteConfig.Builder newBuilder(MuteConfig prototype)
Parameter
Name Description
prototype MuteConfig
Returns
Type Description
MuteConfig.Builder

parseDelimitedFrom(InputStream input)

public static MuteConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MuteConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MuteConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MuteConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static MuteConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
MuteConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MuteConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MuteConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MuteConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
MuteConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MuteConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MuteConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MuteConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
MuteConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MuteConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MuteConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static MuteConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MuteConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MuteConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MuteConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static MuteConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
MuteConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MuteConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MuteConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<MuteConfig> parser()
Returns
Type Description
Parser<MuteConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public 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 = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public 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 = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public MuteConfig getDefaultInstanceForType()
Returns
Type Description
MuteConfig

getDescription()

public String getDescription()

A description of the mute config.

string description = 2;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

A description of the mute config.

string description = 2;

Returns
Type Description
ByteString

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 = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The filter.

getFilterBytes()

public 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 = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for filter.

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 = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The mostRecentEditor.

getMostRecentEditorBytes()

public 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 = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for mostRecentEditor.

getName()

public String getName()

This field will be ignored if provided on config creation. The following list shows some examples of the format:

  • organizations/{organization}/muteConfigs/{mute_config} + organizations/{organization}locations/{location}//muteConfigs/{mute_config}
  • folders/{folder}/muteConfigs/{mute_config}
  • folders/{folder}/locations/{location}/muteConfigs/{mute_config}
  • projects/{project}/muteConfigs/{mute_config}
  • projects/{project}/locations/{location}/muteConfigs/{mute_config}

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

This field will be ignored if provided on config creation. The following list shows some examples of the format:

  • organizations/{organization}/muteConfigs/{mute_config} + organizations/{organization}locations/{location}//muteConfigs/{mute_config}
  • folders/{folder}/muteConfigs/{mute_config}
  • folders/{folder}/locations/{location}/muteConfigs/{mute_config}
  • projects/{project}/muteConfigs/{mute_config}
  • projects/{project}/locations/{location}/muteConfigs/{mute_config}

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<MuteConfig> getParserForType()
Returns
Type Description
Parser<MuteConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getType()

public MuteConfig.MuteConfigType getType()

Required. The type of the mute config, which determines what type of mute state the config affects. Immutable after creation.

.google.cloud.securitycenter.v2.MuteConfig.MuteConfigType type = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
MuteConfig.MuteConfigType

The type.

getTypeValue()

public int getTypeValue()

Required. The type of the mute config, which determines what type of mute state the config affects. Immutable after creation.

.google.cloud.securitycenter.v2.MuteConfig.MuteConfigType type = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for type.

getUpdateTime()

public 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 = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public 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 = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

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 = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

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 = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public MuteConfig.Builder newBuilderForType()
Returns
Type Description
MuteConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected MuteConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
MuteConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public MuteConfig.Builder toBuilder()
Returns
Type Description
MuteConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException