Constructor Detail

Method Detail

• body

   final ExperimentCreateParams.Builder body(ExperimentCreateParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • projectId

  • baseExpId

  • datasetId

  • datasetVersion

  • description

  • etc.

• projectId

   final ExperimentCreateParams.Builder projectId(String projectId)

  Unique identifier for the project that the experiment belongs under

• projectId

   final ExperimentCreateParams.Builder projectId(JsonField<String> projectId)

  Sets Builder.projectId to an arbitrary JSON value.

  You should usually call Builder.projectId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• baseExpId

   final ExperimentCreateParams.Builder baseExpId(String baseExpId)

  Id of default base experiment to compare against when viewing this experiment

• baseExpId

   final ExperimentCreateParams.Builder baseExpId(Optional<String> baseExpId)

  Alias for calling Builder.baseExpId with baseExpId.orElse(null).

• baseExpId

   final ExperimentCreateParams.Builder baseExpId(JsonField<String> baseExpId)

  Sets Builder.baseExpId to an arbitrary JSON value.

  You should usually call Builder.baseExpId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• datasetId

   final ExperimentCreateParams.Builder datasetId(String datasetId)

  Identifier of the linked dataset, or null if the experiment is not linked to a dataset

• datasetId

   final ExperimentCreateParams.Builder datasetId(Optional<String> datasetId)

  Alias for calling Builder.datasetId with datasetId.orElse(null).

• datasetId

   final ExperimentCreateParams.Builder datasetId(JsonField<String> datasetId)

  Sets Builder.datasetId to an arbitrary JSON value.

  You should usually call Builder.datasetId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• datasetVersion

   final ExperimentCreateParams.Builder datasetVersion(String datasetVersion)

  Version number of the linked dataset the experiment was run against. This can be used to reproduce the experiment after the dataset has been modified.

• datasetVersion

   final ExperimentCreateParams.Builder datasetVersion(Optional<String> datasetVersion)

  Alias for calling Builder.datasetVersion with datasetVersion.orElse(null).

• datasetVersion

   final ExperimentCreateParams.Builder datasetVersion(JsonField<String> datasetVersion)

  Sets Builder.datasetVersion to an arbitrary JSON value.

  You should usually call Builder.datasetVersion with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• description

   final ExperimentCreateParams.Builder description(String description)

  Textual description of the experiment

• description

   final ExperimentCreateParams.Builder description(Optional<String> description)

  Alias for calling Builder.description with description.orElse(null).

• description

   final ExperimentCreateParams.Builder description(JsonField<String> description)

  Sets Builder.description to an arbitrary JSON value.

  You should usually call Builder.description with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• ensureNew

   final ExperimentCreateParams.Builder ensureNew(Boolean ensureNew)

  Normally, creating an experiment with the same name as an existing experiment will return the existing one un-modified. But if ensure_new is true, registration will generate a new experiment with a unique name in case of a conflict.

• ensureNew

   final ExperimentCreateParams.Builder ensureNew(Boolean ensureNew)

  Alias for Builder.ensureNew.

  This unboxed primitive overload exists for backwards compatibility.

• ensureNew

   final ExperimentCreateParams.Builder ensureNew(Optional<Boolean> ensureNew)

  Alias for calling Builder.ensureNew with ensureNew.orElse(null).

• ensureNew

   final ExperimentCreateParams.Builder ensureNew(JsonField<Boolean> ensureNew)

  Sets Builder.ensureNew to an arbitrary JSON value.

  You should usually call Builder.ensureNew with a well-typed Boolean value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• metadata

   final ExperimentCreateParams.Builder metadata(ExperimentCreateParams.Metadata metadata)

  User-controlled metadata about the experiment

• metadata

   final ExperimentCreateParams.Builder metadata(Optional<ExperimentCreateParams.Metadata> metadata)

  Alias for calling Builder.metadata with metadata.orElse(null).

• metadata

   final ExperimentCreateParams.Builder metadata(JsonField<ExperimentCreateParams.Metadata> metadata)

  Sets Builder.metadata to an arbitrary JSON value.

  You should usually call Builder.metadata with a well-typed Metadata value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• name

   final ExperimentCreateParams.Builder name(String name)

  Name of the experiment. Within a project, experiment names are unique

• name

   final ExperimentCreateParams.Builder name(Optional<String> name)

  Alias for calling Builder.name with name.orElse(null).

• name

   final ExperimentCreateParams.Builder name(JsonField<String> name)

  Sets Builder.name to an arbitrary JSON value.

  You should usually call Builder.name with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• public_

   final ExperimentCreateParams.Builder public_(Boolean public_)

  Whether or not the experiment is public. Public experiments can be viewed by anybody inside or outside the organization

• public_

   final ExperimentCreateParams.Builder public_(Boolean public_)

  Alias for Builder.public_.

  This unboxed primitive overload exists for backwards compatibility.

• public_

   final ExperimentCreateParams.Builder public_(Optional<Boolean> public_)

  Alias for calling Builder.public_ with public_.orElse(null).

• public_

   final ExperimentCreateParams.Builder public_(JsonField<Boolean> public_)

  Sets Builder.public_ to an arbitrary JSON value.

  You should usually call Builder.public_ with a well-typed Boolean value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• repoInfo

   final ExperimentCreateParams.Builder repoInfo(RepoInfo repoInfo)

  Metadata about the state of the repo when the experiment was created

• repoInfo

   final ExperimentCreateParams.Builder repoInfo(Optional<RepoInfo> repoInfo)

  Alias for calling Builder.repoInfo with repoInfo.orElse(null).

• repoInfo

   final ExperimentCreateParams.Builder repoInfo(JsonField<RepoInfo> repoInfo)

  Sets Builder.repoInfo to an arbitrary JSON value.

  You should usually call Builder.repoInfo with a well-typed RepoInfo value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalBodyProperties

   final ExperimentCreateParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final ExperimentCreateParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final ExperimentCreateParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final ExperimentCreateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final ExperimentCreateParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final ExperimentCreateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final ExperimentCreateParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final ExperimentCreateParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final ExperimentCreateParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final ExperimentCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final ExperimentCreateParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final ExperimentCreateParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final ExperimentCreateParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final ExperimentCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final ExperimentCreateParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final ExperimentCreateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final ExperimentCreateParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final ExperimentCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final ExperimentCreateParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final ExperimentCreateParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final ExperimentCreateParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final ExperimentCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final ExperimentCreateParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final ExperimentCreateParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final ExperimentCreateParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final ExperimentCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final ExperimentCreateParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final ExperimentCreateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final ExperimentCreateParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final ExperimentCreateParams build()

  Returns an immutable instance of ExperimentCreateParams.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .projectId()