Class Watchlist.Builder (0.1.0)

public static final class Watchlist.Builder extends GeneratedMessageV3.Builder<Watchlist.Builder> implements WatchlistOrBuilder

A watchlist is a list of entities that allows for bulk operations over the included entities.

Protobuf type google.cloud.chronicle.v1.Watchlist

Implements

WatchlistOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Watchlist build()
Returns
Type Description
Watchlist

buildPartial()

public Watchlist buildPartial()
Returns
Type Description
Watchlist

clear()

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

clearCreateTime()

public Watchlist.Builder clearCreateTime()

Output only. Time the watchlist was created.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Watchlist.Builder

clearDescription()

public Watchlist.Builder clearDescription()

Optional. Description of the watchlist.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Watchlist.Builder

This builder for chaining.

clearDisplayName()

public Watchlist.Builder clearDisplayName()

Required. Display name of the watchlist. Note that it must be at least one character and less than 63 characters (https://google.aip.dev/148).

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Watchlist.Builder

This builder for chaining.

clearEntityCount()

public Watchlist.Builder clearEntityCount()

Output only. Entity count in the watchlist.

.google.cloud.chronicle.v1.Watchlist.EntityCount entity_count = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Watchlist.Builder

clearEntityPopulationMechanism()

public Watchlist.Builder clearEntityPopulationMechanism()

Required. Mechanism to populate entities in the watchlist.

.google.cloud.chronicle.v1.Watchlist.EntityPopulationMechanism entity_population_mechanism = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Watchlist.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearMultiplyingFactor()

public Watchlist.Builder clearMultiplyingFactor()

Optional. Weight applied to the risk score for entities in this watchlist. The default is 1.0 if it is not specified.

float multiplying_factor = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Watchlist.Builder

This builder for chaining.

clearName()

public Watchlist.Builder clearName()

Identifier. Resource name of the watchlist. Format: projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
Watchlist.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearUpdateTime()

public Watchlist.Builder clearUpdateTime()

Output only. Time the watchlist was last updated.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Watchlist.Builder

clearWatchlistUserPreferences()

public Watchlist.Builder clearWatchlistUserPreferences()

Optional. User preferences for watchlist configuration.

.google.cloud.chronicle.v1.WatchlistUserPreferences watchlist_user_preferences = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Watchlist.Builder

clone()

public Watchlist.Builder clone()
Returns
Type Description
Watchlist.Builder
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. Time the watchlist was created.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Time the watchlist was created.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time the watchlist was created.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Watchlist getDefaultInstanceForType()
Returns
Type Description
Watchlist

getDescription()

public String getDescription()

Optional. Description of the watchlist.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Description of the watchlist.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

Required. Display name of the watchlist. Note that it must be at least one character and less than 63 characters (https://google.aip.dev/148).

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. Display name of the watchlist. Note that it must be at least one character and less than 63 characters (https://google.aip.dev/148).

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getEntityCount()

public Watchlist.EntityCount getEntityCount()

Output only. Entity count in the watchlist.

.google.cloud.chronicle.v1.Watchlist.EntityCount entity_count = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Watchlist.EntityCount

The entityCount.

getEntityCountBuilder()

public Watchlist.EntityCount.Builder getEntityCountBuilder()

Output only. Entity count in the watchlist.

.google.cloud.chronicle.v1.Watchlist.EntityCount entity_count = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Watchlist.EntityCount.Builder

getEntityCountOrBuilder()

public Watchlist.EntityCountOrBuilder getEntityCountOrBuilder()

Output only. Entity count in the watchlist.

.google.cloud.chronicle.v1.Watchlist.EntityCount entity_count = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Watchlist.EntityCountOrBuilder

getEntityPopulationMechanism()

public Watchlist.EntityPopulationMechanism getEntityPopulationMechanism()

Required. Mechanism to populate entities in the watchlist.

.google.cloud.chronicle.v1.Watchlist.EntityPopulationMechanism entity_population_mechanism = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Watchlist.EntityPopulationMechanism

The entityPopulationMechanism.

getEntityPopulationMechanismBuilder()

public Watchlist.EntityPopulationMechanism.Builder getEntityPopulationMechanismBuilder()

Required. Mechanism to populate entities in the watchlist.

.google.cloud.chronicle.v1.Watchlist.EntityPopulationMechanism entity_population_mechanism = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Watchlist.EntityPopulationMechanism.Builder

getEntityPopulationMechanismOrBuilder()

public Watchlist.EntityPopulationMechanismOrBuilder getEntityPopulationMechanismOrBuilder()

Required. Mechanism to populate entities in the watchlist.

.google.cloud.chronicle.v1.Watchlist.EntityPopulationMechanism entity_population_mechanism = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Watchlist.EntityPopulationMechanismOrBuilder

getMultiplyingFactor()

public float getMultiplyingFactor()

Optional. Weight applied to the risk score for entities in this watchlist. The default is 1.0 if it is not specified.

float multiplying_factor = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
float

The multiplyingFactor.

getName()

public String getName()

Identifier. Resource name of the watchlist. Format: projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. Resource name of the watchlist. Format: projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Time the watchlist was last updated.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Time the watchlist was last updated.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Time the watchlist was last updated.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getWatchlistUserPreferences()

public WatchlistUserPreferences getWatchlistUserPreferences()

Optional. User preferences for watchlist configuration.

.google.cloud.chronicle.v1.WatchlistUserPreferences watchlist_user_preferences = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WatchlistUserPreferences

The watchlistUserPreferences.

getWatchlistUserPreferencesBuilder()

public WatchlistUserPreferences.Builder getWatchlistUserPreferencesBuilder()

Optional. User preferences for watchlist configuration.

.google.cloud.chronicle.v1.WatchlistUserPreferences watchlist_user_preferences = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WatchlistUserPreferences.Builder

getWatchlistUserPreferencesOrBuilder()

public WatchlistUserPreferencesOrBuilder getWatchlistUserPreferencesOrBuilder()

Optional. User preferences for watchlist configuration.

.google.cloud.chronicle.v1.WatchlistUserPreferences watchlist_user_preferences = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WatchlistUserPreferencesOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Time the watchlist was created.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasEntityCount()

public boolean hasEntityCount()

Output only. Entity count in the watchlist.

.google.cloud.chronicle.v1.Watchlist.EntityCount entity_count = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the entityCount field is set.

hasEntityPopulationMechanism()

public boolean hasEntityPopulationMechanism()

Required. Mechanism to populate entities in the watchlist.

.google.cloud.chronicle.v1.Watchlist.EntityPopulationMechanism entity_population_mechanism = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the entityPopulationMechanism field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Time the watchlist was last updated.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hasWatchlistUserPreferences()

public boolean hasWatchlistUserPreferences()

Optional. User preferences for watchlist configuration.

.google.cloud.chronicle.v1.WatchlistUserPreferences watchlist_user_preferences = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the watchlistUserPreferences 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 Watchlist.Builder mergeCreateTime(Timestamp value)

Output only. Time the watchlist was created.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Watchlist.Builder

mergeEntityCount(Watchlist.EntityCount value)

public Watchlist.Builder mergeEntityCount(Watchlist.EntityCount value)

Output only. Entity count in the watchlist.

.google.cloud.chronicle.v1.Watchlist.EntityCount entity_count = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Watchlist.EntityCount
Returns
Type Description
Watchlist.Builder

mergeEntityPopulationMechanism(Watchlist.EntityPopulationMechanism value)

public Watchlist.Builder mergeEntityPopulationMechanism(Watchlist.EntityPopulationMechanism value)

Required. Mechanism to populate entities in the watchlist.

.google.cloud.chronicle.v1.Watchlist.EntityPopulationMechanism entity_population_mechanism = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Watchlist.EntityPopulationMechanism
Returns
Type Description
Watchlist.Builder

mergeFrom(Watchlist other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateTime(Timestamp value)

public Watchlist.Builder mergeUpdateTime(Timestamp value)

Output only. Time the watchlist was last updated.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Watchlist.Builder

mergeWatchlistUserPreferences(WatchlistUserPreferences value)

public Watchlist.Builder mergeWatchlistUserPreferences(WatchlistUserPreferences value)

Optional. User preferences for watchlist configuration.

.google.cloud.chronicle.v1.WatchlistUserPreferences watchlist_user_preferences = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value WatchlistUserPreferences
Returns
Type Description
Watchlist.Builder

setCreateTime(Timestamp value)

public Watchlist.Builder setCreateTime(Timestamp value)

Output only. Time the watchlist was created.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Watchlist.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Watchlist.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Time the watchlist was created.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Watchlist.Builder

setDescription(String value)

public Watchlist.Builder setDescription(String value)

Optional. Description of the watchlist.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The description to set.

Returns
Type Description
Watchlist.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Watchlist.Builder setDescriptionBytes(ByteString value)

Optional. Description of the watchlist.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
Watchlist.Builder

This builder for chaining.

setDisplayName(String value)

public Watchlist.Builder setDisplayName(String value)

Required. Display name of the watchlist. Note that it must be at least one character and less than 63 characters (https://google.aip.dev/148).

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
Watchlist.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Watchlist.Builder setDisplayNameBytes(ByteString value)

Required. Display name of the watchlist. Note that it must be at least one character and less than 63 characters (https://google.aip.dev/148).

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
Watchlist.Builder

This builder for chaining.

setEntityCount(Watchlist.EntityCount value)

public Watchlist.Builder setEntityCount(Watchlist.EntityCount value)

Output only. Entity count in the watchlist.

.google.cloud.chronicle.v1.Watchlist.EntityCount entity_count = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Watchlist.EntityCount
Returns
Type Description
Watchlist.Builder

setEntityCount(Watchlist.EntityCount.Builder builderForValue)

public Watchlist.Builder setEntityCount(Watchlist.EntityCount.Builder builderForValue)

Output only. Entity count in the watchlist.

.google.cloud.chronicle.v1.Watchlist.EntityCount entity_count = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Watchlist.EntityCount.Builder
Returns
Type Description
Watchlist.Builder

setEntityPopulationMechanism(Watchlist.EntityPopulationMechanism value)

public Watchlist.Builder setEntityPopulationMechanism(Watchlist.EntityPopulationMechanism value)

Required. Mechanism to populate entities in the watchlist.

.google.cloud.chronicle.v1.Watchlist.EntityPopulationMechanism entity_population_mechanism = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Watchlist.EntityPopulationMechanism
Returns
Type Description
Watchlist.Builder

setEntityPopulationMechanism(Watchlist.EntityPopulationMechanism.Builder builderForValue)

public Watchlist.Builder setEntityPopulationMechanism(Watchlist.EntityPopulationMechanism.Builder builderForValue)

Required. Mechanism to populate entities in the watchlist.

.google.cloud.chronicle.v1.Watchlist.EntityPopulationMechanism entity_population_mechanism = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Watchlist.EntityPopulationMechanism.Builder
Returns
Type Description
Watchlist.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setMultiplyingFactor(float value)

public Watchlist.Builder setMultiplyingFactor(float value)

Optional. Weight applied to the risk score for entities in this watchlist. The default is 1.0 if it is not specified.

float multiplying_factor = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value float

The multiplyingFactor to set.

Returns
Type Description
Watchlist.Builder

This builder for chaining.

setName(String value)

public Watchlist.Builder setName(String value)

Identifier. Resource name of the watchlist. Format: projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Watchlist.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Watchlist.Builder setNameBytes(ByteString value)

Identifier. Resource name of the watchlist. Format: projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Watchlist.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateTime(Timestamp value)

public Watchlist.Builder setUpdateTime(Timestamp value)

Output only. Time the watchlist was last updated.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Watchlist.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Watchlist.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Time the watchlist was last updated.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Watchlist.Builder

setWatchlistUserPreferences(WatchlistUserPreferences value)

public Watchlist.Builder setWatchlistUserPreferences(WatchlistUserPreferences value)

Optional. User preferences for watchlist configuration.

.google.cloud.chronicle.v1.WatchlistUserPreferences watchlist_user_preferences = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value WatchlistUserPreferences
Returns
Type Description
Watchlist.Builder

setWatchlistUserPreferences(WatchlistUserPreferences.Builder builderForValue)

public Watchlist.Builder setWatchlistUserPreferences(WatchlistUserPreferences.Builder builderForValue)

Optional. User preferences for watchlist configuration.

.google.cloud.chronicle.v1.WatchlistUserPreferences watchlist_user_preferences = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue WatchlistUserPreferences.Builder
Returns
Type Description
Watchlist.Builder