Package com.google.cloud.chronicle.v1

Interface WatchlistOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Watchlist, Watchlist.Builder
@Generated public interface WatchlistOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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:
      The name.

    • getNameBytes

      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];
      Returns:
      The bytes for name.

    • getDisplayName

      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:
      The displayName.

    • getDisplayNameBytes

      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];
      Returns:
      The bytes for displayName.

    • getDescription

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

    • getDescriptionBytes

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

    • getMultiplyingFactor

      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:
      The multiplyingFactor.

    • hasEntityPopulationMechanism

      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:
      Whether the entityPopulationMechanism field is set.

    • getEntityPopulationMechanism

      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:
      The entityPopulationMechanism.

    • getEntityPopulationMechanismOrBuilder

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

    • hasEntityCount

      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:
      Whether the entityCount field is set.

    • getEntityCount

      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:
      The entityCount.

    • getEntityCountOrBuilder

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

    • hasCreateTime

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

    • getCreateTime

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

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Time the watchlist was created.
      .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUpdateTime

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

    • getUpdateTime

      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];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

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

    • hasWatchlistUserPreferences

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

    • getWatchlistUserPreferences

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

    • getWatchlistUserPreferencesOrBuilder

      WatchlistUserPreferencesOrBuilder getWatchlistUserPreferencesOrBuilder()
       Optional. User preferences for watchlist configuration.
      .google.cloud.chronicle.v1.WatchlistUserPreferences watchlist_user_preferences = 10 [(.google.api.field_behavior) = OPTIONAL];