Class MuteConfig.Builder (2.53.0)

public static final class MuteConfig.Builder extends GeneratedMessageV3.Builder<MuteConfig.Builder> 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 Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public MuteConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
MuteConfig.Builder
Overrides

build()

public MuteConfig build()
Returns
Type Description
MuteConfig

buildPartial()

public MuteConfig buildPartial()
Returns
Type Description
MuteConfig

clear()

public MuteConfig.Builder clear()
Returns
Type Description
MuteConfig.Builder
Overrides

clearCreateTime()

public MuteConfig.Builder clearCreateTime()

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
MuteConfig.Builder

clearDescription()

public MuteConfig.Builder clearDescription()

A description of the mute config.

string description = 2;

Returns
Type Description
MuteConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public MuteConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
MuteConfig.Builder
Overrides

clearFilter()

public MuteConfig.Builder clearFilter()

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
MuteConfig.Builder

This builder for chaining.

clearMostRecentEditor()

public MuteConfig.Builder clearMostRecentEditor()

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
MuteConfig.Builder

This builder for chaining.

clearName()

public MuteConfig.Builder clearName()

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
MuteConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public MuteConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
MuteConfig.Builder
Overrides

clearType()

public MuteConfig.Builder clearType()

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.Builder

This builder for chaining.

clearUpdateTime()

public MuteConfig.Builder clearUpdateTime()

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
MuteConfig.Builder

clone()

public MuteConfig.Builder clone()
Returns
Type Description
MuteConfig.Builder
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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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
Builder

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public MuteConfig.Builder mergeCreateTime(Timestamp value)

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

Parameter
Name Description
value Timestamp
Returns
Type Description
MuteConfig.Builder

mergeFrom(MuteConfig other)

public MuteConfig.Builder mergeFrom(MuteConfig other)
Parameter
Name Description
other MuteConfig
Returns
Type Description
MuteConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public MuteConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MuteConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public MuteConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
MuteConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final MuteConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
MuteConfig.Builder
Overrides

mergeUpdateTime(Timestamp value)

public MuteConfig.Builder mergeUpdateTime(Timestamp value)

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

Parameter
Name Description
value Timestamp
Returns
Type Description
MuteConfig.Builder

setCreateTime(Timestamp value)

public MuteConfig.Builder setCreateTime(Timestamp value)

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

Parameter
Name Description
value Timestamp
Returns
Type Description
MuteConfig.Builder

setCreateTime(Timestamp.Builder builderForValue)

public MuteConfig.Builder setCreateTime(Timestamp.Builder builderForValue)

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
MuteConfig.Builder

setDescription(String value)

public MuteConfig.Builder setDescription(String value)

A description of the mute config.

string description = 2;

Parameter
Name Description
value String

The description to set.

Returns
Type Description
MuteConfig.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public MuteConfig.Builder setDescriptionBytes(ByteString value)

A description of the mute config.

string description = 2;

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
MuteConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public MuteConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
MuteConfig.Builder
Overrides

setFilter(String value)

public MuteConfig.Builder setFilter(String value)

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
MuteConfig.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public MuteConfig.Builder setFilterBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
MuteConfig.Builder

This builder for chaining.

setMostRecentEditor(String value)

public MuteConfig.Builder setMostRecentEditor(String value)

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

Parameter
Name Description
value String

The mostRecentEditor to set.

Returns
Type Description
MuteConfig.Builder

This builder for chaining.

setMostRecentEditorBytes(ByteString value)

public MuteConfig.Builder setMostRecentEditorBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for mostRecentEditor to set.

Returns
Type Description
MuteConfig.Builder

This builder for chaining.

setName(String value)

public MuteConfig.Builder setName(String value)

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;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
MuteConfig.Builder

This builder for chaining.

setNameBytes(ByteString value)

public MuteConfig.Builder setNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
MuteConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public MuteConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
MuteConfig.Builder
Overrides

setType(MuteConfig.MuteConfigType value)

public MuteConfig.Builder setType(MuteConfig.MuteConfigType value)

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

Parameter
Name Description
value MuteConfig.MuteConfigType

The type to set.

Returns
Type Description
MuteConfig.Builder

This builder for chaining.

setTypeValue(int value)

public MuteConfig.Builder setTypeValue(int value)

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

Parameter
Name Description
value int

The enum numeric value on the wire for type to set.

Returns
Type Description
MuteConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final MuteConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
MuteConfig.Builder
Overrides

setUpdateTime(Timestamp value)

public MuteConfig.Builder setUpdateTime(Timestamp value)

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

Parameter
Name Description
value Timestamp
Returns
Type Description
MuteConfig.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public MuteConfig.Builder setUpdateTime(Timestamp.Builder builderForValue)

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
MuteConfig.Builder