Package com.google.cloud.chronicle.v1

Class Watchlist.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Watchlist.Builder>
com.google.cloud.chronicle.v1.Watchlist.Builder
All Implemented Interfaces:
WatchlistOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Watchlist
public static final class Watchlist.Builder extends com.google.protobuf.GeneratedMessage.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

  • 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.Builder<Watchlist.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Watchlist.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public Watchlist.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Watchlist.Builder>

    • mergeFrom

      public Watchlist.Builder mergeFrom(Watchlist other)

    • isInitialized

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

    • mergeFrom

      public Watchlist.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Watchlist.Builder>
      Throws:
      IOException

    • 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.

    • setName

      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];
      Parameters:
      value - The name to set.
      Returns:
      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:
      This builder for chaining.

    • setNameBytes

      public Watchlist.Builder setNameBytes(com.google.protobuf.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];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • 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.

    • setDisplayName

      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];
      Parameters:
      value - The displayName to set.
      Returns:
      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:
      This builder for chaining.

    • setDisplayNameBytes

      public Watchlist.Builder setDisplayNameBytes(com.google.protobuf.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];
      Parameters:
      value - The bytes for displayName to set.
      Returns:
      This builder for chaining.

    • 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.

    • setDescription

      public Watchlist.Builder setDescription(String value)
       Optional. Description of the watchlist.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The description to set.
      Returns:
      This builder for chaining.

    • clearDescription

      public Watchlist.Builder clearDescription()
       Optional. Description of the watchlist.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setDescriptionBytes

      public Watchlist.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
       Optional. Description of the watchlist.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for description to set.
      Returns:
      This builder for chaining.

    • 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.

    • setMultiplyingFactor

      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];
      Parameters:
      value - The multiplyingFactor to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

    • 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.

    • setEntityPopulationMechanism

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

    • setEntityPopulationMechanism

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

    • mergeEntityPopulationMechanism

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

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

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

    • 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.

    • setEntityCount

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

    • setEntityCount

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

    • mergeEntityCount

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

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

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

    • 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.

    • setCreateTime

      public Watchlist.Builder setCreateTime(com.google.protobuf.Timestamp value)
       Output only. Time the watchlist was created.
      .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setCreateTime

      public Watchlist.Builder setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Output only. Time the watchlist was created.
      .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeCreateTime

      public Watchlist.Builder mergeCreateTime(com.google.protobuf.Timestamp value)
       Output only. Time the watchlist was created.
      .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearCreateTime

      public Watchlist.Builder clearCreateTime()
       Output only. Time the watchlist was created.
      .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getCreateTimeBuilder

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

    • 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.

    • setUpdateTime

      public Watchlist.Builder setUpdateTime(com.google.protobuf.Timestamp value)
       Output only. Time the watchlist was last updated.
      .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setUpdateTime

      public Watchlist.Builder setUpdateTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Output only. Time the watchlist was last updated.
      .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeUpdateTime

      public Watchlist.Builder mergeUpdateTime(com.google.protobuf.Timestamp value)
       Output only. Time the watchlist was last updated.
      .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

    • getUpdateTimeBuilder

      public com.google.protobuf.Timestamp.Builder getUpdateTimeBuilder()
       Output only. Time the watchlist was last updated.
      .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • 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.

    • setWatchlistUserPreferences

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

    • setWatchlistUserPreferences

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

    • mergeWatchlistUserPreferences

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

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

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

    • 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