public final class Watchlist extends GeneratedMessageV3 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
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 |
|
ENTITY_COUNT_FIELD_NUMBER
public static final int ENTITY_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENTITY_POPULATION_MECHANISM_FIELD_NUMBER
public static final int ENTITY_POPULATION_MECHANISM_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MULTIPLYING_FACTOR_FIELD_NUMBER
public static final int MULTIPLYING_FACTOR_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
WATCHLIST_USER_PREFERENCES_FIELD_NUMBER
public static final int WATCHLIST_USER_PREFERENCES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Watchlist getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Watchlist.Builder newBuilder()
newBuilder(Watchlist prototype)
public static Watchlist.Builder newBuilder(Watchlist prototype)
| Parameter |
| Name |
Description |
prototype |
Watchlist
|
public static Watchlist parseDelimitedFrom(InputStream input)
public static Watchlist parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Watchlist parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Watchlist parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Watchlist parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Watchlist parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Watchlist parseFrom(CodedInputStream input)
public static Watchlist parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Watchlist parseFrom(InputStream input)
public static Watchlist parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Watchlist parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Watchlist parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Watchlist> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Time the watchlist was created.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Watchlist getDefaultInstanceForType()
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.
|
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];
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];
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];
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];
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()
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.
|
getParserForType()
public Parser<Watchlist> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Time the watchlist was last updated.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getWatchlistUserPreferences()
public WatchlistUserPreferences getWatchlistUserPreferences()
Optional. User preferences for watchlist configuration.
.google.cloud.chronicle.v1.WatchlistUserPreferences watchlist_user_preferences = 10 [(.google.api.field_behavior) = OPTIONAL];
getWatchlistUserPreferencesOrBuilder()
public WatchlistUserPreferencesOrBuilder getWatchlistUserPreferencesOrBuilder()
Optional. User preferences for watchlist configuration.
.google.cloud.chronicle.v1.WatchlistUserPreferences watchlist_user_preferences = 10 [(.google.api.field_behavior) = OPTIONAL];
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Watchlist.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Watchlist.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Watchlist.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
