Interface MuteConfigOrBuilder (2.56.0) 

public interface MuteConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCreateTime()

public abstract 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 abstract 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
Type Description
TimestampOrBuilder

getDescription()

public abstract String getDescription()

A description of the mute config.

string description = 3;

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

A description of the mute config.

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

getDisplayName() (deprecated)

public abstract 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 abstract 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 abstract 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 abstract 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];

Returns
Type Description
TimestampOrBuilder

getFilter()

public abstract 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 abstract 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 abstract 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 abstract 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()

public abstract 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} 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 abstract 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.

getType()

public abstract 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];

Returns
Type Description
MuteConfig.MuteConfigType

The type.

getTypeValue()

public abstract 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 abstract 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 abstract 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
Type Description
TimestampOrBuilder

hasCreateTime()

public abstract 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 abstract 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 abstract 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.