Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
google-native.ml/v1.getStudy
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
Gets a study.
Using getStudy
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getStudy(args: GetStudyArgs, opts?: InvokeOptions): Promise<GetStudyResult>
function getStudyOutput(args: GetStudyOutputArgs, opts?: InvokeOptions): Output<GetStudyResult>def get_study(location: Optional[str] = None,
              project: Optional[str] = None,
              study_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetStudyResult
def get_study_output(location: Optional[pulumi.Input[str]] = None,
              project: Optional[pulumi.Input[str]] = None,
              study_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetStudyResult]func LookupStudy(ctx *Context, args *LookupStudyArgs, opts ...InvokeOption) (*LookupStudyResult, error)
func LookupStudyOutput(ctx *Context, args *LookupStudyOutputArgs, opts ...InvokeOption) LookupStudyResultOutput> Note: This function is named LookupStudy in the Go SDK.
public static class GetStudy 
{
    public static Task<GetStudyResult> InvokeAsync(GetStudyArgs args, InvokeOptions? opts = null)
    public static Output<GetStudyResult> Invoke(GetStudyInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetStudyResult> getStudy(GetStudyArgs args, InvokeOptions options)
public static Output<GetStudyResult> getStudy(GetStudyArgs args, InvokeOptions options)
fn::invoke:
  function: google-native:ml/v1:getStudy
  arguments:
    # arguments dictionaryThe following arguments are supported:
getStudy Result
The following output properties are available:
- CreateTime string
- Time at which the study was created.
- InactiveReason string
- A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.
- Name string
- The name of a study.
- State string
- The detailed state of a study.
- StudyConfig Pulumi.Google Native. Ml. V1. Outputs. Google Cloud Ml V1__Study Config Response 
- Configuration of the study.
- CreateTime string
- Time at which the study was created.
- InactiveReason string
- A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.
- Name string
- The name of a study.
- State string
- The detailed state of a study.
- StudyConfig GoogleCloud Ml V1__Study Config Response 
- Configuration of the study.
- createTime String
- Time at which the study was created.
- inactiveReason String
- A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.
- name String
- The name of a study.
- state String
- The detailed state of a study.
- studyConfig GoogleCloud Ml V1__Study Config Response 
- Configuration of the study.
- createTime string
- Time at which the study was created.
- inactiveReason string
- A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.
- name string
- The name of a study.
- state string
- The detailed state of a study.
- studyConfig GoogleCloud Ml V1__Study Config Response 
- Configuration of the study.
- create_time str
- Time at which the study was created.
- inactive_reason str
- A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.
- name str
- The name of a study.
- state str
- The detailed state of a study.
- study_config GoogleCloud Ml V1Study Config Response 
- Configuration of the study.
- createTime String
- Time at which the study was created.
- inactiveReason String
- A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.
- name String
- The name of a study.
- state String
- The detailed state of a study.
- studyConfig Property Map
- Configuration of the study.
Supporting Types
GoogleCloudMlV1_AutomatedStoppingConfig_DecayCurveAutomatedStoppingConfigResponse          
- UseElapsed boolTime 
- If true, measurement.elapsed_time is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.steps will be used as the x-axis.
- UseElapsed boolTime 
- If true, measurement.elapsed_time is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.steps will be used as the x-axis.
- useElapsed BooleanTime 
- If true, measurement.elapsed_time is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.steps will be used as the x-axis.
- useElapsed booleanTime 
- If true, measurement.elapsed_time is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.steps will be used as the x-axis.
- use_elapsed_ booltime 
- If true, measurement.elapsed_time is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.steps will be used as the x-axis.
- useElapsed BooleanTime 
- If true, measurement.elapsed_time is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.steps will be used as the x-axis.
GoogleCloudMlV1_AutomatedStoppingConfig_MedianAutomatedStoppingConfigResponse         
- UseElapsed boolTime 
- If true, the median automated stopping rule applies to measurement.use_elapsed_time, which means the elapsed_time field of the current trial's latest measurement is used to compute the median objective value for each completed trial.
- UseElapsed boolTime 
- If true, the median automated stopping rule applies to measurement.use_elapsed_time, which means the elapsed_time field of the current trial's latest measurement is used to compute the median objective value for each completed trial.
- useElapsed BooleanTime 
- If true, the median automated stopping rule applies to measurement.use_elapsed_time, which means the elapsed_time field of the current trial's latest measurement is used to compute the median objective value for each completed trial.
- useElapsed booleanTime 
- If true, the median automated stopping rule applies to measurement.use_elapsed_time, which means the elapsed_time field of the current trial's latest measurement is used to compute the median objective value for each completed trial.
- use_elapsed_ booltime 
- If true, the median automated stopping rule applies to measurement.use_elapsed_time, which means the elapsed_time field of the current trial's latest measurement is used to compute the median objective value for each completed trial.
- useElapsed BooleanTime 
- If true, the median automated stopping rule applies to measurement.use_elapsed_time, which means the elapsed_time field of the current trial's latest measurement is used to compute the median objective value for each completed trial.
GoogleCloudMlV1_StudyConfigParameterSpec_CategoricalValueSpecResponse         
- Values List<string>
- Must be specified if type is CATEGORICAL. The list of possible categories.
- Values []string
- Must be specified if type is CATEGORICAL. The list of possible categories.
- values List<String>
- Must be specified if type is CATEGORICAL. The list of possible categories.
- values string[]
- Must be specified if type is CATEGORICAL. The list of possible categories.
- values Sequence[str]
- Must be specified if type is CATEGORICAL. The list of possible categories.
- values List<String>
- Must be specified if type is CATEGORICAL. The list of possible categories.
GoogleCloudMlV1_StudyConfigParameterSpec_DiscreteValueSpecResponse         
- Values List<double>
- Must be specified if type is DISCRETE. A list of feasible points. The list should be in strictly increasing order. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.
- Values []float64
- Must be specified if type is DISCRETE. A list of feasible points. The list should be in strictly increasing order. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.
- values List<Double>
- Must be specified if type is DISCRETE. A list of feasible points. The list should be in strictly increasing order. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.
- values number[]
- Must be specified if type is DISCRETE. A list of feasible points. The list should be in strictly increasing order. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.
- values Sequence[float]
- Must be specified if type is DISCRETE. A list of feasible points. The list should be in strictly increasing order. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.
- values List<Number>
- Must be specified if type is DISCRETE. A list of feasible points. The list should be in strictly increasing order. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.
GoogleCloudMlV1_StudyConfigParameterSpec_DoubleValueSpecResponse         
GoogleCloudMlV1_StudyConfigParameterSpec_IntegerValueSpecResponse         
GoogleCloudMlV1_StudyConfigParameterSpec_MatchingParentCategoricalValueSpecResponse           
- Values List<string>
- Matches values of the parent parameter with type 'CATEGORICAL'. All values must exist in categorical_value_specof parent parameter.
- Values []string
- Matches values of the parent parameter with type 'CATEGORICAL'. All values must exist in categorical_value_specof parent parameter.
- values List<String>
- Matches values of the parent parameter with type 'CATEGORICAL'. All values must exist in categorical_value_specof parent parameter.
- values string[]
- Matches values of the parent parameter with type 'CATEGORICAL'. All values must exist in categorical_value_specof parent parameter.
- values Sequence[str]
- Matches values of the parent parameter with type 'CATEGORICAL'. All values must exist in categorical_value_specof parent parameter.
- values List<String>
- Matches values of the parent parameter with type 'CATEGORICAL'. All values must exist in categorical_value_specof parent parameter.
GoogleCloudMlV1_StudyConfigParameterSpec_MatchingParentDiscreteValueSpecResponse           
- Values List<double>
- Matches values of the parent parameter with type 'DISCRETE'. All values must exist in discrete_value_specof parent parameter.
- Values []float64
- Matches values of the parent parameter with type 'DISCRETE'. All values must exist in discrete_value_specof parent parameter.
- values List<Double>
- Matches values of the parent parameter with type 'DISCRETE'. All values must exist in discrete_value_specof parent parameter.
- values number[]
- Matches values of the parent parameter with type 'DISCRETE'. All values must exist in discrete_value_specof parent parameter.
- values Sequence[float]
- Matches values of the parent parameter with type 'DISCRETE'. All values must exist in discrete_value_specof parent parameter.
- values List<Number>
- Matches values of the parent parameter with type 'DISCRETE'. All values must exist in discrete_value_specof parent parameter.
GoogleCloudMlV1_StudyConfigParameterSpec_MatchingParentIntValueSpecResponse           
- Values List<string>
- Matches values of the parent parameter with type 'INTEGER'. All values must lie in integer_value_specof parent parameter.
- Values []string
- Matches values of the parent parameter with type 'INTEGER'. All values must lie in integer_value_specof parent parameter.
- values List<String>
- Matches values of the parent parameter with type 'INTEGER'. All values must lie in integer_value_specof parent parameter.
- values string[]
- Matches values of the parent parameter with type 'INTEGER'. All values must lie in integer_value_specof parent parameter.
- values Sequence[str]
- Matches values of the parent parameter with type 'INTEGER'. All values must lie in integer_value_specof parent parameter.
- values List<String>
- Matches values of the parent parameter with type 'INTEGER'. All values must lie in integer_value_specof parent parameter.
GoogleCloudMlV1_StudyConfig_MetricSpecResponse      
GoogleCloudMlV1_StudyConfig_ParameterSpecResponse      
- CategoricalValue Pulumi.Spec Google Native. Ml. V1. Inputs. Google Cloud Ml V1_Study Config Parameter Spec_Categorical Value Spec Response 
- The value spec for a 'CATEGORICAL' parameter.
- ChildParameter List<Pulumi.Specs Google Native. Ml. V1. Inputs. Google Cloud Ml V1_Study Config_Parameter Spec Response> 
- A child node is active if the parameter's value matches the child node's matching_parent_values. If two items in child_parameter_specs have the same name, they must have disjoint matching_parent_values.
- DiscreteValue Pulumi.Spec Google Native. Ml. V1. Inputs. Google Cloud Ml V1_Study Config Parameter Spec_Discrete Value Spec Response 
- The value spec for a 'DISCRETE' parameter.
- DoubleValue Pulumi.Spec Google Native. Ml. V1. Inputs. Google Cloud Ml V1_Study Config Parameter Spec_Double Value Spec Response 
- The value spec for a 'DOUBLE' parameter.
- IntegerValue Pulumi.Spec Google Native. Ml. V1. Inputs. Google Cloud Ml V1_Study Config Parameter Spec_Integer Value Spec Response 
- The value spec for an 'INTEGER' parameter.
- Parameter string
- The parameter name must be unique amongst all ParameterSpecs.
- ParentCategorical Pulumi.Values Google Native. Ml. V1. Inputs. Google Cloud Ml V1_Study Config Parameter Spec_Matching Parent Categorical Value Spec Response 
- ParentDiscrete Pulumi.Values Google Native. Ml. V1. Inputs. Google Cloud Ml V1_Study Config Parameter Spec_Matching Parent Discrete Value Spec Response 
- ParentInt Pulumi.Values Google Native. Ml. V1. Inputs. Google Cloud Ml V1_Study Config Parameter Spec_Matching Parent Int Value Spec Response 
- ScaleType string
- How the parameter should be scaled. Leave unset for categorical parameters.
- Type string
- The type of the parameter.
- CategoricalValue GoogleSpec Cloud Ml V1_Study Config Parameter Spec_Categorical Value Spec Response 
- The value spec for a 'CATEGORICAL' parameter.
- ChildParameter []GoogleSpecs Cloud Ml V1_Study Config_Parameter Spec Response 
- A child node is active if the parameter's value matches the child node's matching_parent_values. If two items in child_parameter_specs have the same name, they must have disjoint matching_parent_values.
- DiscreteValue GoogleSpec Cloud Ml V1_Study Config Parameter Spec_Discrete Value Spec Response 
- The value spec for a 'DISCRETE' parameter.
- DoubleValue GoogleSpec Cloud Ml V1_Study Config Parameter Spec_Double Value Spec Response 
- The value spec for a 'DOUBLE' parameter.
- IntegerValue GoogleSpec Cloud Ml V1_Study Config Parameter Spec_Integer Value Spec Response 
- The value spec for an 'INTEGER' parameter.
- Parameter string
- The parameter name must be unique amongst all ParameterSpecs.
- ParentCategorical GoogleValues Cloud Ml V1_Study Config Parameter Spec_Matching Parent Categorical Value Spec Response 
- ParentDiscrete GoogleValues Cloud Ml V1_Study Config Parameter Spec_Matching Parent Discrete Value Spec Response 
- ParentInt GoogleValues Cloud Ml V1_Study Config Parameter Spec_Matching Parent Int Value Spec Response 
- ScaleType string
- How the parameter should be scaled. Leave unset for categorical parameters.
- Type string
- The type of the parameter.
- categoricalValue GoogleSpec Cloud Ml V1_Study Config Parameter Spec_Categorical Value Spec Response 
- The value spec for a 'CATEGORICAL' parameter.
- childParameter List<GoogleSpecs Cloud Ml V1_Study Config_Parameter Spec Response> 
- A child node is active if the parameter's value matches the child node's matching_parent_values. If two items in child_parameter_specs have the same name, they must have disjoint matching_parent_values.
- discreteValue GoogleSpec Cloud Ml V1_Study Config Parameter Spec_Discrete Value Spec Response 
- The value spec for a 'DISCRETE' parameter.
- doubleValue GoogleSpec Cloud Ml V1_Study Config Parameter Spec_Double Value Spec Response 
- The value spec for a 'DOUBLE' parameter.
- integerValue GoogleSpec Cloud Ml V1_Study Config Parameter Spec_Integer Value Spec Response 
- The value spec for an 'INTEGER' parameter.
- parameter String
- The parameter name must be unique amongst all ParameterSpecs.
- parentCategorical GoogleValues Cloud Ml V1_Study Config Parameter Spec_Matching Parent Categorical Value Spec Response 
- parentDiscrete GoogleValues Cloud Ml V1_Study Config Parameter Spec_Matching Parent Discrete Value Spec Response 
- parentInt GoogleValues Cloud Ml V1_Study Config Parameter Spec_Matching Parent Int Value Spec Response 
- scaleType String
- How the parameter should be scaled. Leave unset for categorical parameters.
- type String
- The type of the parameter.
- categoricalValue GoogleSpec Cloud Ml V1_Study Config Parameter Spec_Categorical Value Spec Response 
- The value spec for a 'CATEGORICAL' parameter.
- childParameter GoogleSpecs Cloud Ml V1_Study Config_Parameter Spec Response[] 
- A child node is active if the parameter's value matches the child node's matching_parent_values. If two items in child_parameter_specs have the same name, they must have disjoint matching_parent_values.
- discreteValue GoogleSpec Cloud Ml V1_Study Config Parameter Spec_Discrete Value Spec Response 
- The value spec for a 'DISCRETE' parameter.
- doubleValue GoogleSpec Cloud Ml V1_Study Config Parameter Spec_Double Value Spec Response 
- The value spec for a 'DOUBLE' parameter.
- integerValue GoogleSpec Cloud Ml V1_Study Config Parameter Spec_Integer Value Spec Response 
- The value spec for an 'INTEGER' parameter.
- parameter string
- The parameter name must be unique amongst all ParameterSpecs.
- parentCategorical GoogleValues Cloud Ml V1_Study Config Parameter Spec_Matching Parent Categorical Value Spec Response 
- parentDiscrete GoogleValues Cloud Ml V1_Study Config Parameter Spec_Matching Parent Discrete Value Spec Response 
- parentInt GoogleValues Cloud Ml V1_Study Config Parameter Spec_Matching Parent Int Value Spec Response 
- scaleType string
- How the parameter should be scaled. Leave unset for categorical parameters.
- type string
- The type of the parameter.
- categorical_value_ Googlespec Cloud Ml V1Study Config Parameter Spec_Categorical Value Spec Response 
- The value spec for a 'CATEGORICAL' parameter.
- child_parameter_ Sequence[Googlespecs Cloud Ml V1Study Config_Parameter Spec Response] 
- A child node is active if the parameter's value matches the child node's matching_parent_values. If two items in child_parameter_specs have the same name, they must have disjoint matching_parent_values.
- discrete_value_ Googlespec Cloud Ml V1Study Config Parameter Spec_Discrete Value Spec Response 
- The value spec for a 'DISCRETE' parameter.
- double_value_ Googlespec Cloud Ml V1Study Config Parameter Spec_Double Value Spec Response 
- The value spec for a 'DOUBLE' parameter.
- integer_value_ Googlespec Cloud Ml V1Study Config Parameter Spec_Integer Value Spec Response 
- The value spec for an 'INTEGER' parameter.
- parameter str
- The parameter name must be unique amongst all ParameterSpecs.
- parent_categorical_ Googlevalues Cloud Ml V1Study Config Parameter Spec_Matching Parent Categorical Value Spec Response 
- parent_discrete_ Googlevalues Cloud Ml V1Study Config Parameter Spec_Matching Parent Discrete Value Spec Response 
- parent_int_ Googlevalues Cloud Ml V1Study Config Parameter Spec_Matching Parent Int Value Spec Response 
- scale_type str
- How the parameter should be scaled. Leave unset for categorical parameters.
- type str
- The type of the parameter.
- categoricalValue Property MapSpec 
- The value spec for a 'CATEGORICAL' parameter.
- childParameter List<Property Map>Specs 
- A child node is active if the parameter's value matches the child node's matching_parent_values. If two items in child_parameter_specs have the same name, they must have disjoint matching_parent_values.
- discreteValue Property MapSpec 
- The value spec for a 'DISCRETE' parameter.
- doubleValue Property MapSpec 
- The value spec for a 'DOUBLE' parameter.
- integerValue Property MapSpec 
- The value spec for an 'INTEGER' parameter.
- parameter String
- The parameter name must be unique amongst all ParameterSpecs.
- parentCategorical Property MapValues 
- parentDiscrete Property MapValues 
- parentInt Property MapValues 
- scaleType String
- How the parameter should be scaled. Leave unset for categorical parameters.
- type String
- The type of the parameter.
GoogleCloudMlV1__AutomatedStoppingConfigResponse      
GoogleCloudMlV1__StudyConfigResponse     
- Algorithm string
- The search algorithm specified for the study.
- AutomatedStopping Pulumi.Config Google Native. Ml. V1. Inputs. Google Cloud Ml V1__Automated Stopping Config Response 
- Configuration for automated stopping of unpromising Trials.
- Metrics
List<Pulumi.Google Native. Ml. V1. Inputs. Google Cloud Ml V1_Study Config_Metric Spec Response> 
- Metric specs for the study.
- Parameters
List<Pulumi.Google Native. Ml. V1. Inputs. Google Cloud Ml V1_Study Config_Parameter Spec Response> 
- The set of parameters to tune.
- Algorithm string
- The search algorithm specified for the study.
- AutomatedStopping GoogleConfig Cloud Ml V1__Automated Stopping Config Response 
- Configuration for automated stopping of unpromising Trials.
- Metrics
[]GoogleCloud Ml V1_Study Config_Metric Spec Response 
- Metric specs for the study.
- Parameters
[]GoogleCloud Ml V1_Study Config_Parameter Spec Response 
- The set of parameters to tune.
- algorithm String
- The search algorithm specified for the study.
- automatedStopping GoogleConfig Cloud Ml V1__Automated Stopping Config Response 
- Configuration for automated stopping of unpromising Trials.
- metrics
List<GoogleCloud Ml V1_Study Config_Metric Spec Response> 
- Metric specs for the study.
- parameters
List<GoogleCloud Ml V1_Study Config_Parameter Spec Response> 
- The set of parameters to tune.
- algorithm string
- The search algorithm specified for the study.
- automatedStopping GoogleConfig Cloud Ml V1__Automated Stopping Config Response 
- Configuration for automated stopping of unpromising Trials.
- metrics
GoogleCloud Ml V1_Study Config_Metric Spec Response[] 
- Metric specs for the study.
- parameters
GoogleCloud Ml V1_Study Config_Parameter Spec Response[] 
- The set of parameters to tune.
- algorithm str
- The search algorithm specified for the study.
- automated_stopping_ Googleconfig Cloud Ml V1Automated Stopping Config Response 
- Configuration for automated stopping of unpromising Trials.
- metrics
Sequence[GoogleCloud Ml V1Study Config_Metric Spec Response] 
- Metric specs for the study.
- parameters
Sequence[GoogleCloud Ml V1Study Config_Parameter Spec Response] 
- The set of parameters to tune.
- algorithm String
- The search algorithm specified for the study.
- automatedStopping Property MapConfig 
- Configuration for automated stopping of unpromising Trials.
- metrics List<Property Map>
- Metric specs for the study.
- parameters List<Property Map>
- The set of parameters to tune.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi