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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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 |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
EXPIRY_TIME_FIELD_NUMBER
public static final int EXPIRY_TIME_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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static MuteConfig.Builder newBuilder()
newBuilder(MuteConfig prototype)
public static MuteConfig.Builder newBuilder(MuteConfig prototype)
public static MuteConfig parseDelimitedFrom(InputStream input)
public static MuteConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static MuteConfig parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static MuteConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static MuteConfig parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static MuteConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static MuteConfig parseFrom(CodedInputStream input)
public static MuteConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static MuteConfig parseFrom(InputStream input)
public static MuteConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static MuteConfig parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static MuteConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<MuteConfig> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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 |
| 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 = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public MuteConfig getDefaultInstanceForType()
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=74
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=74
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.
|
getExpiryTime()
public Timestamp getExpiryTime()
Optional. The expiry of the mute config. Only applicable for dynamic
configs. If the expiry is set, when the config expires, it is removed from
all findings.
.google.protobuf.Timestamp expiry_time = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
Timestamp |
The expiryTime.
|
getExpiryTimeOrBuilder()
public TimestampOrBuilder getExpiryTimeOrBuilder()
Optional. The expiry of the mute config. Only applicable for dynamic
configs. If the expiry is set, when the config expires, it is removed from
all findings.
.google.protobuf.Timestamp expiry_time = 9 [(.google.api.field_behavior) = OPTIONAL];
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 |
| 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 = 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}
organizations/{organization}/locations/global/muteConfigs/{mute_config}
folders/{folder}/locations/global/muteConfigs/{mute_config}
projects/{project}/locations/global/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}
organizations/{organization}/locations/global/muteConfigs/{mute_config}
folders/{folder}/locations/global/muteConfigs/{mute_config}
projects/{project}/locations/global/muteConfigs/{mute_config}
string name = 1;
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<MuteConfig> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getType()
public MuteConfig.MuteConfigType getType()
Optional. The type of the mute config, which determines what type of mute
state the config affects. The static mute state takes precedence over the
dynamic mute state. Immutable after creation. STATIC by default if not set
during creation.
.google.cloud.securitycenter.v1.MuteConfig.MuteConfigType type = 8 [(.google.api.field_behavior) = OPTIONAL];
getTypeValue()
public int getTypeValue()
Optional. The type of the mute config, which determines what type of mute
state the config affects. The static mute state takes precedence over the
dynamic mute state. Immutable after creation. STATIC by default if not set
during creation.
.google.cloud.securitycenter.v1.MuteConfig.MuteConfigType type = 8 [(.google.api.field_behavior) = OPTIONAL];
| 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 = 6 [(.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 = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.
|
hasExpiryTime()
public boolean hasExpiryTime()
Optional. The expiry of the mute config. Only applicable for dynamic
configs. If the expiry is set, when the config expires, it is removed from
all findings.
.google.protobuf.Timestamp expiry_time = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the expiryTime 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 |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public MuteConfig.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected MuteConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public MuteConfig.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
