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.v1.MuteConfig
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
MOST_RECENT_EDITOR_FIELD_NUMBER
public static final int MOST_RECENT_EDITOR_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static MuteConfig getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static MuteConfig.Builder newBuilder()
Returns
newBuilder(MuteConfig prototype)
public static MuteConfig.Builder newBuilder(MuteConfig prototype)
Parameter
Returns
public static MuteConfig parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static MuteConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static MuteConfig parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static MuteConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static MuteConfig parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static MuteConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static MuteConfig parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static MuteConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static MuteConfig parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static MuteConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static MuteConfig parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static MuteConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<MuteConfig> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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 = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
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 = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getDefaultInstanceForType()
public MuteConfig getDefaultInstanceForType()
Returns
getDescription()
public String getDescription()
A description of the mute config.
string description = 3;
Returns
Type | Description |
String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
A description of the mute config.
string description = 3;
Returns
Type | Description |
ByteString | The bytes for description.
|
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];
Returns
Type | Description |
String | The displayName.
|
getDisplayNameBytes() (deprecated)
public 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];
Returns
Type | Description |
ByteString | The bytes for displayName.
|
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];
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 = 4 [(.google.api.field_behavior) = REQUIRED];
Returns
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];
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 = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type | Description |
ByteString | The bytes for mostRecentEditor.
|
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;
Returns
Type | Description |
String | The name.
|
getNameBytes()
public 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;
Returns
getParserForType()
public Parser<MuteConfig> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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 = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
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 = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
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];
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 = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public MuteConfig.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected MuteConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public MuteConfig.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions