Package com.google.cloud.discoveryengine.v1beta

Class Control

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1beta.Control
All Implemented Interfaces:
ControlOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Control extends com.google.protobuf.GeneratedMessage implements ControlOrBuilder
 Defines a conditioned behavior to employ during serving.
 Must be attached to a
 [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] to be
 considered at serving time. Permitted actions dependent on `SolutionType`.
Protobuf type google.cloud.discoveryengine.v1beta.Control
See Also:

  • Field Details

    • BOOST_ACTION_FIELD_NUMBER

      public static final int BOOST_ACTION_FIELD_NUMBER
      See Also:

    • FILTER_ACTION_FIELD_NUMBER

      public static final int FILTER_ACTION_FIELD_NUMBER
      See Also:

    • REDIRECT_ACTION_FIELD_NUMBER

      public static final int REDIRECT_ACTION_FIELD_NUMBER
      See Also:

    • SYNONYMS_ACTION_FIELD_NUMBER

      public static final int SYNONYMS_ACTION_FIELD_NUMBER
      See Also:

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

    • ASSOCIATED_SERVING_CONFIG_IDS_FIELD_NUMBER

      public static final int ASSOCIATED_SERVING_CONFIG_IDS_FIELD_NUMBER
      See Also:

    • SOLUTION_TYPE_FIELD_NUMBER

      public static final int SOLUTION_TYPE_FIELD_NUMBER
      See Also:

    • USE_CASES_FIELD_NUMBER

      public static final int USE_CASES_FIELD_NUMBER
      See Also:

    • CONDITIONS_FIELD_NUMBER

      public static final int CONDITIONS_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

    • getActionCase

      public Control.ActionCase getActionCase()
      Specified by:
      getActionCase in interface ControlOrBuilder

    • hasBoostAction

      public boolean hasBoostAction()
       Defines a boost-type control
      .google.cloud.discoveryengine.v1beta.Control.BoostAction boost_action = 6;
      Specified by:
      hasBoostAction in interface ControlOrBuilder
      Returns:
      Whether the boostAction field is set.

    • getBoostAction

      public Control.BoostAction getBoostAction()
       Defines a boost-type control
      .google.cloud.discoveryengine.v1beta.Control.BoostAction boost_action = 6;
      Specified by:
      getBoostAction in interface ControlOrBuilder
      Returns:
      The boostAction.

    • getBoostActionOrBuilder

      public Control.BoostActionOrBuilder getBoostActionOrBuilder()
       Defines a boost-type control
      .google.cloud.discoveryengine.v1beta.Control.BoostAction boost_action = 6;
      Specified by:
      getBoostActionOrBuilder in interface ControlOrBuilder

    • hasFilterAction

      public boolean hasFilterAction()
       Defines a filter-type control
 Currently not supported by Recommendation
      .google.cloud.discoveryengine.v1beta.Control.FilterAction filter_action = 7;
      Specified by:
      hasFilterAction in interface ControlOrBuilder
      Returns:
      Whether the filterAction field is set.

    • getFilterAction

      public Control.FilterAction getFilterAction()
       Defines a filter-type control
 Currently not supported by Recommendation
      .google.cloud.discoveryengine.v1beta.Control.FilterAction filter_action = 7;
      Specified by:
      getFilterAction in interface ControlOrBuilder
      Returns:
      The filterAction.

    • getFilterActionOrBuilder

      public Control.FilterActionOrBuilder getFilterActionOrBuilder()
       Defines a filter-type control
 Currently not supported by Recommendation
      .google.cloud.discoveryengine.v1beta.Control.FilterAction filter_action = 7;
      Specified by:
      getFilterActionOrBuilder in interface ControlOrBuilder

    • hasRedirectAction

      public boolean hasRedirectAction()
       Defines a redirect-type control.
      .google.cloud.discoveryengine.v1beta.Control.RedirectAction redirect_action = 9;
      Specified by:
      hasRedirectAction in interface ControlOrBuilder
      Returns:
      Whether the redirectAction field is set.

    • getRedirectAction

      public Control.RedirectAction getRedirectAction()
       Defines a redirect-type control.
      .google.cloud.discoveryengine.v1beta.Control.RedirectAction redirect_action = 9;
      Specified by:
      getRedirectAction in interface ControlOrBuilder
      Returns:
      The redirectAction.

    • getRedirectActionOrBuilder

      public Control.RedirectActionOrBuilder getRedirectActionOrBuilder()
       Defines a redirect-type control.
      .google.cloud.discoveryengine.v1beta.Control.RedirectAction redirect_action = 9;
      Specified by:
      getRedirectActionOrBuilder in interface ControlOrBuilder

    • hasSynonymsAction

      public boolean hasSynonymsAction()
       Treats a group of terms as synonyms of one another.
      .google.cloud.discoveryengine.v1beta.Control.SynonymsAction synonyms_action = 10;
      Specified by:
      hasSynonymsAction in interface ControlOrBuilder
      Returns:
      Whether the synonymsAction field is set.

    • getSynonymsAction

      public Control.SynonymsAction getSynonymsAction()
       Treats a group of terms as synonyms of one another.
      .google.cloud.discoveryengine.v1beta.Control.SynonymsAction synonyms_action = 10;
      Specified by:
      getSynonymsAction in interface ControlOrBuilder
      Returns:
      The synonymsAction.

    • getSynonymsActionOrBuilder

      public Control.SynonymsActionOrBuilder getSynonymsActionOrBuilder()
       Treats a group of terms as synonyms of one another.
      .google.cloud.discoveryengine.v1beta.Control.SynonymsAction synonyms_action = 10;
      Specified by:
      getSynonymsActionOrBuilder in interface ControlOrBuilder

    • getName

      public String getName()
       Immutable. Fully qualified name
 `projects/*/locations/global/dataStore/*/controls/*`
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getName in interface ControlOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Immutable. Fully qualified name
 `projects/*/locations/global/dataStore/*/controls/*`
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getNameBytes in interface ControlOrBuilder
      Returns:
      The bytes for name.

    • getDisplayName

      public String getDisplayName()
       Required. Human readable name. The identifier used in UI views.

 Must be UTF-8 encoded string. Length limit is 128 characters.
 Otherwise an INVALID ARGUMENT error is thrown.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayName in interface ControlOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Required. Human readable name. The identifier used in UI views.

 Must be UTF-8 encoded string. Length limit is 128 characters.
 Otherwise an INVALID ARGUMENT error is thrown.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayNameBytes in interface ControlOrBuilder
      Returns:
      The bytes for displayName.

    • getAssociatedServingConfigIdsList

      public com.google.protobuf.ProtocolStringList getAssociatedServingConfigIdsList()
       Output only. List of all
 [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] IDs this
 control is attached to. May take up to 10 minutes to update after changes.
      repeated string associated_serving_config_ids = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAssociatedServingConfigIdsList in interface ControlOrBuilder
      Returns:
      A list containing the associatedServingConfigIds.

    • getAssociatedServingConfigIdsCount

      public int getAssociatedServingConfigIdsCount()
       Output only. List of all
 [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] IDs this
 control is attached to. May take up to 10 minutes to update after changes.
      repeated string associated_serving_config_ids = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAssociatedServingConfigIdsCount in interface ControlOrBuilder
      Returns:
      The count of associatedServingConfigIds.

    • getAssociatedServingConfigIds

      public String getAssociatedServingConfigIds(int index)
       Output only. List of all
 [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] IDs this
 control is attached to. May take up to 10 minutes to update after changes.
      repeated string associated_serving_config_ids = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAssociatedServingConfigIds in interface ControlOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The associatedServingConfigIds at the given index.

    • getAssociatedServingConfigIdsBytes

      public com.google.protobuf.ByteString getAssociatedServingConfigIdsBytes(int index)
       Output only. List of all
 [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] IDs this
 control is attached to. May take up to 10 minutes to update after changes.
      repeated string associated_serving_config_ids = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAssociatedServingConfigIdsBytes in interface ControlOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the associatedServingConfigIds at the given index.

    • getSolutionTypeValue

      public int getSolutionTypeValue()
       Required. Immutable. What solution the control belongs to.

 Must be compatible with vertical of resource.
 Otherwise an INVALID ARGUMENT error is thrown.
      .google.cloud.discoveryengine.v1beta.SolutionType solution_type = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getSolutionTypeValue in interface ControlOrBuilder
      Returns:
      The enum numeric value on the wire for solutionType.

    • getSolutionType

      public SolutionType getSolutionType()
       Required. Immutable. What solution the control belongs to.

 Must be compatible with vertical of resource.
 Otherwise an INVALID ARGUMENT error is thrown.
      .google.cloud.discoveryengine.v1beta.SolutionType solution_type = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getSolutionType in interface ControlOrBuilder
      Returns:
      The solutionType.

    • getUseCasesList

      public List<SearchUseCase> getUseCasesList()
       Specifies the use case for the control.
 Affects what condition fields can be set.
 Only applies to
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 Currently only allow one use case per control.
 Must be set when solution_type is
 [SolutionType.SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
      repeated .google.cloud.discoveryengine.v1beta.SearchUseCase use_cases = 8;
      Specified by:
      getUseCasesList in interface ControlOrBuilder
      Returns:
      A list containing the useCases.

    • getUseCasesCount

      public int getUseCasesCount()
       Specifies the use case for the control.
 Affects what condition fields can be set.
 Only applies to
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 Currently only allow one use case per control.
 Must be set when solution_type is
 [SolutionType.SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
      repeated .google.cloud.discoveryengine.v1beta.SearchUseCase use_cases = 8;
      Specified by:
      getUseCasesCount in interface ControlOrBuilder
      Returns:
      The count of useCases.

    • getUseCases

      public SearchUseCase getUseCases(int index)
       Specifies the use case for the control.
 Affects what condition fields can be set.
 Only applies to
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 Currently only allow one use case per control.
 Must be set when solution_type is
 [SolutionType.SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
      repeated .google.cloud.discoveryengine.v1beta.SearchUseCase use_cases = 8;
      Specified by:
      getUseCases in interface ControlOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The useCases at the given index.

    • getUseCasesValueList

      public List<Integer> getUseCasesValueList()
       Specifies the use case for the control.
 Affects what condition fields can be set.
 Only applies to
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 Currently only allow one use case per control.
 Must be set when solution_type is
 [SolutionType.SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
      repeated .google.cloud.discoveryengine.v1beta.SearchUseCase use_cases = 8;
      Specified by:
      getUseCasesValueList in interface ControlOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for useCases.

    • getUseCasesValue

      public int getUseCasesValue(int index)
       Specifies the use case for the control.
 Affects what condition fields can be set.
 Only applies to
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 Currently only allow one use case per control.
 Must be set when solution_type is
 [SolutionType.SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
      repeated .google.cloud.discoveryengine.v1beta.SearchUseCase use_cases = 8;
      Specified by:
      getUseCasesValue in interface ControlOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of useCases at the given index.

    • getConditionsList

      public List<Condition> getConditionsList()
       Determines when the associated action will trigger.

 Omit to always apply the action.
 Currently only a single condition may be specified.
 Otherwise an INVALID ARGUMENT error is thrown.
      repeated .google.cloud.discoveryengine.v1beta.Condition conditions = 5;
      Specified by:
      getConditionsList in interface ControlOrBuilder

    • getConditionsOrBuilderList

      public List<? extends ConditionOrBuilder> getConditionsOrBuilderList()
       Determines when the associated action will trigger.

 Omit to always apply the action.
 Currently only a single condition may be specified.
 Otherwise an INVALID ARGUMENT error is thrown.
      repeated .google.cloud.discoveryengine.v1beta.Condition conditions = 5;
      Specified by:
      getConditionsOrBuilderList in interface ControlOrBuilder

    • getConditionsCount

      public int getConditionsCount()
       Determines when the associated action will trigger.

 Omit to always apply the action.
 Currently only a single condition may be specified.
 Otherwise an INVALID ARGUMENT error is thrown.
      repeated .google.cloud.discoveryengine.v1beta.Condition conditions = 5;
      Specified by:
      getConditionsCount in interface ControlOrBuilder

    • getConditions

      public Condition getConditions(int index)
       Determines when the associated action will trigger.

 Omit to always apply the action.
 Currently only a single condition may be specified.
 Otherwise an INVALID ARGUMENT error is thrown.
      repeated .google.cloud.discoveryengine.v1beta.Condition conditions = 5;
      Specified by:
      getConditions in interface ControlOrBuilder

    • getConditionsOrBuilder

      public ConditionOrBuilder getConditionsOrBuilder(int index)
       Determines when the associated action will trigger.

 Omit to always apply the action.
 Currently only a single condition may be specified.
 Otherwise an INVALID ARGUMENT error is thrown.
      repeated .google.cloud.discoveryengine.v1beta.Condition conditions = 5;
      Specified by:
      getConditionsOrBuilder in interface ControlOrBuilder

    • 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 Control parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Control.Builder newBuilder()

    • newBuilder

      public static Control.Builder newBuilder(Control prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Control getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Control> 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 Control getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder