Package com.google.cloud.chronicle.v1

Class Watchlist

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.chronicle.v1.Watchlist
All Implemented Interfaces:
WatchlistOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Watchlist extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • MULTIPLYING_FACTOR_FIELD_NUMBER

      public static final int MULTIPLYING_FACTOR_FIELD_NUMBER
      See Also:

    • ENTITY_POPULATION_MECHANISM_FIELD_NUMBER

      public static final int ENTITY_POPULATION_MECHANISM_FIELD_NUMBER
      See Also:

    • ENTITY_COUNT_FIELD_NUMBER

      public static final int ENTITY_COUNT_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • WATCHLIST_USER_PREFERENCES_FIELD_NUMBER

      public static final int WATCHLIST_USER_PREFERENCES_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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];
      Specified by:
      getName in interface WatchlistOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.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];
      Specified by:
      getNameBytes in interface WatchlistOrBuilder
      Returns:
      The bytes for name.

    • 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];
      Specified by:
      getDisplayName in interface WatchlistOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.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];
      Specified by:
      getDisplayNameBytes in interface WatchlistOrBuilder
      Returns:
      The bytes for displayName.

    • getDescription

      public String getDescription()
       Optional. Description of the watchlist.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescription in interface WatchlistOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Optional. Description of the watchlist.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescriptionBytes in interface WatchlistOrBuilder
      Returns:
      The bytes for description.

    • 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];
      Specified by:
      getMultiplyingFactor in interface WatchlistOrBuilder
      Returns:
      The multiplyingFactor.

    • 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];
      Specified by:
      hasEntityPopulationMechanism in interface WatchlistOrBuilder
      Returns:
      Whether the entityPopulationMechanism field is set.

    • 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];
      Specified by:
      getEntityPopulationMechanism in interface WatchlistOrBuilder
      Returns:
      The entityPopulationMechanism.

    • 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];
      Specified by:
      getEntityPopulationMechanismOrBuilder in interface WatchlistOrBuilder

    • 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];
      Specified by:
      hasEntityCount in interface WatchlistOrBuilder
      Returns:
      Whether the entityCount field is set.

    • 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];
      Specified by:
      getEntityCount in interface WatchlistOrBuilder
      Returns:
      The entityCount.

    • 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];
      Specified by:
      getEntityCountOrBuilder in interface WatchlistOrBuilder

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Time the watchlist was created.
      .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface WatchlistOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. Time the watchlist was created.
      .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface WatchlistOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Time the watchlist was created.
      .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface WatchlistOrBuilder

    • hasUpdateTime

      public boolean hasUpdateTime()
       Output only. Time the watchlist was last updated.
      .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateTime in interface WatchlistOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. Time the watchlist was last updated.
      .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface WatchlistOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Time the watchlist was last updated.
      .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface WatchlistOrBuilder

    • hasWatchlistUserPreferences

      public boolean hasWatchlistUserPreferences()
       Optional. User preferences for watchlist configuration.
      .google.cloud.chronicle.v1.WatchlistUserPreferences watchlist_user_preferences = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasWatchlistUserPreferences in interface WatchlistOrBuilder
      Returns:
      Whether the watchlistUserPreferences field is set.

    • getWatchlistUserPreferences

      public WatchlistUserPreferences getWatchlistUserPreferences()
       Optional. User preferences for watchlist configuration.
      .google.cloud.chronicle.v1.WatchlistUserPreferences watchlist_user_preferences = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getWatchlistUserPreferences in interface WatchlistOrBuilder
      Returns:
      The watchlistUserPreferences.

    • getWatchlistUserPreferencesOrBuilder

      public WatchlistUserPreferencesOrBuilder getWatchlistUserPreferencesOrBuilder()
       Optional. User preferences for watchlist configuration.
      .google.cloud.chronicle.v1.WatchlistUserPreferences watchlist_user_preferences = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getWatchlistUserPreferencesOrBuilder in interface WatchlistOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Watchlist parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Watchlist parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Watchlist parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Watchlist parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Watchlist parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Watchlist parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Watchlist parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Watchlist parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Watchlist parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Watchlist parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Watchlist parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Watchlist parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Watchlist.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Watchlist.Builder newBuilder()

    • newBuilder

      public static Watchlist.Builder newBuilder(Watchlist prototype)

    • toBuilder

      public Watchlist.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Watchlist.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Watchlist getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Watchlist> parser()

    • getParserForType

      public com.google.protobuf.Parser<Watchlist> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Watchlist getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder