Package com.google.cloud.aiplatform.v1

Class SuggestTrialsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.SuggestTrialsRequest
All Implemented Interfaces:
SuggestTrialsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SuggestTrialsRequest extends com.google.protobuf.GeneratedMessage implements SuggestTrialsRequestOrBuilder
 Request message for
 [VizierService.SuggestTrials][google.cloud.aiplatform.v1.VizierService.SuggestTrials].
Protobuf type google.cloud.aiplatform.v1.SuggestTrialsRequest
See Also:

  • Field Details

    • PARENT_FIELD_NUMBER

      public static final int PARENT_FIELD_NUMBER
      See Also:

    • SUGGESTION_COUNT_FIELD_NUMBER

      public static final int SUGGESTION_COUNT_FIELD_NUMBER
      See Also:

    • CLIENT_ID_FIELD_NUMBER

      public static final int CLIENT_ID_FIELD_NUMBER
      See Also:

    • CONTEXTS_FIELD_NUMBER

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

    • getParent

      public String getParent()
       Required. The project and location that the Study belongs to.
 Format: `projects/{project}/locations/{location}/studies/{study}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParent in interface SuggestTrialsRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. The project and location that the Study belongs to.
 Format: `projects/{project}/locations/{location}/studies/{study}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParentBytes in interface SuggestTrialsRequestOrBuilder
      Returns:
      The bytes for parent.

    • getSuggestionCount

      public int getSuggestionCount()
       Required. The number of suggestions requested. It must be positive.
      int32 suggestion_count = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getSuggestionCount in interface SuggestTrialsRequestOrBuilder
      Returns:
      The suggestionCount.

    • getClientId

      public String getClientId()
       Required. The identifier of the client that is requesting the suggestion.

 If multiple SuggestTrialsRequests have the same `client_id`,
 the service will return the identical suggested Trial if the Trial is
 pending, and provide a new Trial if the last suggested Trial was completed.
      string client_id = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getClientId in interface SuggestTrialsRequestOrBuilder
      Returns:
      The clientId.

    • getClientIdBytes

      public com.google.protobuf.ByteString getClientIdBytes()
       Required. The identifier of the client that is requesting the suggestion.

 If multiple SuggestTrialsRequests have the same `client_id`,
 the service will return the identical suggested Trial if the Trial is
 pending, and provide a new Trial if the last suggested Trial was completed.
      string client_id = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getClientIdBytes in interface SuggestTrialsRequestOrBuilder
      Returns:
      The bytes for clientId.

    • getContextsList

      public List<TrialContext> getContextsList()
       Optional. This allows you to specify the "context" for a Trial; a context
 is a slice (a subspace) of the search space.

 Typical uses for contexts:
 1) You are using Vizier to tune a server for best performance, but there's
 a strong weekly cycle.  The context specifies the day-of-week.
 This allows Tuesday to generalize from Wednesday without assuming that
 everything is identical.
 2) Imagine you're optimizing some medical treatment for people.
 As they walk in the door, you know certain facts about them
 (e.g. sex, weight, height, blood-pressure).  Put that information in the
 context, and Vizier will adapt its suggestions to the patient.
 3) You want to do a fair A/B test efficiently.  Specify the "A" and "B"
 conditions as contexts, and Vizier will generalize between "A" and "B"
 conditions.  If they are similar, this will allow Vizier to converge
 to the optimum faster than if "A" and "B" were separate Studies.
 NOTE: You can also enter contexts as REQUESTED Trials, e.g. via the
 CreateTrial() RPC; that's the asynchronous option where you don't need a
 close association between contexts and suggestions.

 NOTE: All the Parameters you set in a context MUST be defined in the
 Study.
 NOTE: You must supply 0 or $suggestion_count contexts.
 If you don't supply any contexts, Vizier will make suggestions
 from the full search space specified in the StudySpec; if you supply
 a full set of context, each suggestion will match the corresponding
 context.
 NOTE: A Context with no features set matches anything, and allows
 suggestions from the full search space.
 NOTE: Contexts MUST lie within the search space specified in the
 StudySpec.  It's an error if they don't.
 NOTE: Contexts preferentially match ACTIVE then REQUESTED trials before
 new suggestions are generated.
 NOTE: Generation of suggestions involves a match between a Context and
 (optionally) a REQUESTED trial; if that match is not fully specified, a
 suggestion will be geneated in the merged subspace.
      repeated .google.cloud.aiplatform.v1.TrialContext contexts = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getContextsList in interface SuggestTrialsRequestOrBuilder

    • getContextsOrBuilderList

      public List<? extends TrialContextOrBuilder> getContextsOrBuilderList()
       Optional. This allows you to specify the "context" for a Trial; a context
 is a slice (a subspace) of the search space.

 Typical uses for contexts:
 1) You are using Vizier to tune a server for best performance, but there's
 a strong weekly cycle.  The context specifies the day-of-week.
 This allows Tuesday to generalize from Wednesday without assuming that
 everything is identical.
 2) Imagine you're optimizing some medical treatment for people.
 As they walk in the door, you know certain facts about them
 (e.g. sex, weight, height, blood-pressure).  Put that information in the
 context, and Vizier will adapt its suggestions to the patient.
 3) You want to do a fair A/B test efficiently.  Specify the "A" and "B"
 conditions as contexts, and Vizier will generalize between "A" and "B"
 conditions.  If they are similar, this will allow Vizier to converge
 to the optimum faster than if "A" and "B" were separate Studies.
 NOTE: You can also enter contexts as REQUESTED Trials, e.g. via the
 CreateTrial() RPC; that's the asynchronous option where you don't need a
 close association between contexts and suggestions.

 NOTE: All the Parameters you set in a context MUST be defined in the
 Study.
 NOTE: You must supply 0 or $suggestion_count contexts.
 If you don't supply any contexts, Vizier will make suggestions
 from the full search space specified in the StudySpec; if you supply
 a full set of context, each suggestion will match the corresponding
 context.
 NOTE: A Context with no features set matches anything, and allows
 suggestions from the full search space.
 NOTE: Contexts MUST lie within the search space specified in the
 StudySpec.  It's an error if they don't.
 NOTE: Contexts preferentially match ACTIVE then REQUESTED trials before
 new suggestions are generated.
 NOTE: Generation of suggestions involves a match between a Context and
 (optionally) a REQUESTED trial; if that match is not fully specified, a
 suggestion will be geneated in the merged subspace.
      repeated .google.cloud.aiplatform.v1.TrialContext contexts = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getContextsOrBuilderList in interface SuggestTrialsRequestOrBuilder

    • getContextsCount

      public int getContextsCount()
       Optional. This allows you to specify the "context" for a Trial; a context
 is a slice (a subspace) of the search space.

 Typical uses for contexts:
 1) You are using Vizier to tune a server for best performance, but there's
 a strong weekly cycle.  The context specifies the day-of-week.
 This allows Tuesday to generalize from Wednesday without assuming that
 everything is identical.
 2) Imagine you're optimizing some medical treatment for people.
 As they walk in the door, you know certain facts about them
 (e.g. sex, weight, height, blood-pressure).  Put that information in the
 context, and Vizier will adapt its suggestions to the patient.
 3) You want to do a fair A/B test efficiently.  Specify the "A" and "B"
 conditions as contexts, and Vizier will generalize between "A" and "B"
 conditions.  If they are similar, this will allow Vizier to converge
 to the optimum faster than if "A" and "B" were separate Studies.
 NOTE: You can also enter contexts as REQUESTED Trials, e.g. via the
 CreateTrial() RPC; that's the asynchronous option where you don't need a
 close association between contexts and suggestions.

 NOTE: All the Parameters you set in a context MUST be defined in the
 Study.
 NOTE: You must supply 0 or $suggestion_count contexts.
 If you don't supply any contexts, Vizier will make suggestions
 from the full search space specified in the StudySpec; if you supply
 a full set of context, each suggestion will match the corresponding
 context.
 NOTE: A Context with no features set matches anything, and allows
 suggestions from the full search space.
 NOTE: Contexts MUST lie within the search space specified in the
 StudySpec.  It's an error if they don't.
 NOTE: Contexts preferentially match ACTIVE then REQUESTED trials before
 new suggestions are generated.
 NOTE: Generation of suggestions involves a match between a Context and
 (optionally) a REQUESTED trial; if that match is not fully specified, a
 suggestion will be geneated in the merged subspace.
      repeated .google.cloud.aiplatform.v1.TrialContext contexts = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getContextsCount in interface SuggestTrialsRequestOrBuilder

    • getContexts

      public TrialContext getContexts(int index)
       Optional. This allows you to specify the "context" for a Trial; a context
 is a slice (a subspace) of the search space.

 Typical uses for contexts:
 1) You are using Vizier to tune a server for best performance, but there's
 a strong weekly cycle.  The context specifies the day-of-week.
 This allows Tuesday to generalize from Wednesday without assuming that
 everything is identical.
 2) Imagine you're optimizing some medical treatment for people.
 As they walk in the door, you know certain facts about them
 (e.g. sex, weight, height, blood-pressure).  Put that information in the
 context, and Vizier will adapt its suggestions to the patient.
 3) You want to do a fair A/B test efficiently.  Specify the "A" and "B"
 conditions as contexts, and Vizier will generalize between "A" and "B"
 conditions.  If they are similar, this will allow Vizier to converge
 to the optimum faster than if "A" and "B" were separate Studies.
 NOTE: You can also enter contexts as REQUESTED Trials, e.g. via the
 CreateTrial() RPC; that's the asynchronous option where you don't need a
 close association between contexts and suggestions.

 NOTE: All the Parameters you set in a context MUST be defined in the
 Study.
 NOTE: You must supply 0 or $suggestion_count contexts.
 If you don't supply any contexts, Vizier will make suggestions
 from the full search space specified in the StudySpec; if you supply
 a full set of context, each suggestion will match the corresponding
 context.
 NOTE: A Context with no features set matches anything, and allows
 suggestions from the full search space.
 NOTE: Contexts MUST lie within the search space specified in the
 StudySpec.  It's an error if they don't.
 NOTE: Contexts preferentially match ACTIVE then REQUESTED trials before
 new suggestions are generated.
 NOTE: Generation of suggestions involves a match between a Context and
 (optionally) a REQUESTED trial; if that match is not fully specified, a
 suggestion will be geneated in the merged subspace.
      repeated .google.cloud.aiplatform.v1.TrialContext contexts = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getContexts in interface SuggestTrialsRequestOrBuilder

    • getContextsOrBuilder

      public TrialContextOrBuilder getContextsOrBuilder(int index)
       Optional. This allows you to specify the "context" for a Trial; a context
 is a slice (a subspace) of the search space.

 Typical uses for contexts:
 1) You are using Vizier to tune a server for best performance, but there's
 a strong weekly cycle.  The context specifies the day-of-week.
 This allows Tuesday to generalize from Wednesday without assuming that
 everything is identical.
 2) Imagine you're optimizing some medical treatment for people.
 As they walk in the door, you know certain facts about them
 (e.g. sex, weight, height, blood-pressure).  Put that information in the
 context, and Vizier will adapt its suggestions to the patient.
 3) You want to do a fair A/B test efficiently.  Specify the "A" and "B"
 conditions as contexts, and Vizier will generalize between "A" and "B"
 conditions.  If they are similar, this will allow Vizier to converge
 to the optimum faster than if "A" and "B" were separate Studies.
 NOTE: You can also enter contexts as REQUESTED Trials, e.g. via the
 CreateTrial() RPC; that's the asynchronous option where you don't need a
 close association between contexts and suggestions.

 NOTE: All the Parameters you set in a context MUST be defined in the
 Study.
 NOTE: You must supply 0 or $suggestion_count contexts.
 If you don't supply any contexts, Vizier will make suggestions
 from the full search space specified in the StudySpec; if you supply
 a full set of context, each suggestion will match the corresponding
 context.
 NOTE: A Context with no features set matches anything, and allows
 suggestions from the full search space.
 NOTE: Contexts MUST lie within the search space specified in the
 StudySpec.  It's an error if they don't.
 NOTE: Contexts preferentially match ACTIVE then REQUESTED trials before
 new suggestions are generated.
 NOTE: Generation of suggestions involves a match between a Context and
 (optionally) a REQUESTED trial; if that match is not fully specified, a
 suggestion will be geneated in the merged subspace.
      repeated .google.cloud.aiplatform.v1.TrialContext contexts = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getContextsOrBuilder in interface SuggestTrialsRequestOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SuggestTrialsRequest.Builder newBuilder()

    • newBuilder

      public static SuggestTrialsRequest.Builder newBuilder(SuggestTrialsRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SuggestTrialsRequest getDefaultInstance()

    • parser

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

    • getParserForType

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