Class BulkMuteFindingsRequest (2.63.0)

public final class BulkMuteFindingsRequest extends GeneratedMessageV3 implements BulkMuteFindingsRequestOrBuilder

Request message for bulk findings update.

Note:

  1. If multiple bulk update requests match the same resource, the order in which they get executed is not defined.
  2. Once a bulk operation is started, there is no way to stop it.

Protobuf type google.cloud.securitycenter.v1.BulkMuteFindingsRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

MUTE_ANNOTATION_FIELD_NUMBER

public static final int MUTE_ANNOTATION_FIELD_NUMBER
Field Value
Type Description
int

MUTE_STATE_FIELD_NUMBER

public static final int MUTE_STATE_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BulkMuteFindingsRequest getDefaultInstance()
Returns
Type Description
BulkMuteFindingsRequest

getDescriptor()

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

newBuilder()

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

newBuilder(BulkMuteFindingsRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public BulkMuteFindingsRequest getDefaultInstanceForType()
Returns
Type Description
BulkMuteFindingsRequest

getFilter()

public String getFilter()

Expression that identifies findings that should be updated. The expression is a list of zero or more restrictions combined via logical operators AND and OR. Parentheses are supported, and OR has higher precedence than AND.

Restrictions have the form <field> <operator> <value> and may have a - character in front of them to indicate negation. The fields map to those defined in the corresponding resource.

The supported operators are:

  • = for all value types.
  • >, <, >=, <= for integer values.
  • :, meaning substring matching, for strings.

    The supported value types are:

  • string literals in quotes.

  • integer literals without quotes.
  • boolean literals true and false without quotes.

string filter = 2;

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Expression that identifies findings that should be updated. The expression is a list of zero or more restrictions combined via logical operators AND and OR. Parentheses are supported, and OR has higher precedence than AND.

Restrictions have the form <field> <operator> <value> and may have a - character in front of them to indicate negation. The fields map to those defined in the corresponding resource.

The supported operators are:

  • = for all value types.
  • >, <, >=, <= for integer values.
  • :, meaning substring matching, for strings.

    The supported value types are:

  • string literals in quotes.

  • integer literals without quotes.
  • boolean literals true and false without quotes.

string filter = 2;

Returns
Type Description
ByteString

The bytes for filter.

getMuteAnnotation() (deprecated)

public String getMuteAnnotation()

Deprecated. google.cloud.securitycenter.v1.BulkMuteFindingsRequest.mute_annotation is deprecated. See google/cloud/securitycenter/v1/securitycenter_service.proto;l=1138

This can be a mute configuration name or any identifier for mute/unmute of findings based on the filter.

string mute_annotation = 3 [deprecated = true];

Returns
Type Description
String

The muteAnnotation.

getMuteAnnotationBytes() (deprecated)

public ByteString getMuteAnnotationBytes()

Deprecated. google.cloud.securitycenter.v1.BulkMuteFindingsRequest.mute_annotation is deprecated. See google/cloud/securitycenter/v1/securitycenter_service.proto;l=1138

This can be a mute configuration name or any identifier for mute/unmute of findings based on the filter.

string mute_annotation = 3 [deprecated = true];

Returns
Type Description
ByteString

The bytes for muteAnnotation.

getMuteState()

public BulkMuteFindingsRequest.MuteState getMuteState()

Optional. All findings matching the given filter will have their mute state set to this value. The default value is MUTED. Setting this to UNDEFINED will clear the mute state on all matching findings.

.google.cloud.securitycenter.v1.BulkMuteFindingsRequest.MuteState mute_state = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BulkMuteFindingsRequest.MuteState

The muteState.

getMuteStateValue()

public int getMuteStateValue()

Optional. All findings matching the given filter will have their mute state set to this value. The default value is MUTED. Setting this to UNDEFINED will clear the mute state on all matching findings.

.google.cloud.securitycenter.v1.BulkMuteFindingsRequest.MuteState mute_state = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for muteState.

getParent()

public String getParent()

Required. The parent, at which bulk action needs to be applied. Its format is organizations/[organization_id], folders/[folder_id], projects/[project_id].

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent, at which bulk action needs to be applied. Its format is organizations/[organization_id], folders/[folder_id], projects/[project_id].

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 BulkMuteFindingsRequest.Builder newBuilderForType()
Returns
Type Description
BulkMuteFindingsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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