1. Packages
  2. Google Cloud Native
  3. API Docs
  4. aiplatform
  5. aiplatform/v1beta1
  6. getExperiment

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.aiplatform/v1beta1.getExperiment

Explore with Pulumi AI

google-native logo

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

    Using getExperiment

    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 getExperiment(args: GetExperimentArgs, opts?: InvokeOptions): Promise<GetExperimentResult>
    function getExperimentOutput(args: GetExperimentOutputArgs, opts?: InvokeOptions): Output<GetExperimentResult>
    def get_experiment(experiment_id: Optional[str] = None,
                       location: Optional[str] = None,
                       project: Optional[str] = None,
                       tensorboard_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetExperimentResult
    def get_experiment_output(experiment_id: Optional[pulumi.Input[str]] = None,
                       location: Optional[pulumi.Input[str]] = None,
                       project: Optional[pulumi.Input[str]] = None,
                       tensorboard_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetExperimentResult]
    func LookupExperiment(ctx *Context, args *LookupExperimentArgs, opts ...InvokeOption) (*LookupExperimentResult, error)
    func LookupExperimentOutput(ctx *Context, args *LookupExperimentOutputArgs, opts ...InvokeOption) LookupExperimentResultOutput

    > Note: This function is named LookupExperiment in the Go SDK.

    public static class GetExperiment 
    {
        public static Task<GetExperimentResult> InvokeAsync(GetExperimentArgs args, InvokeOptions? opts = null)
        public static Output<GetExperimentResult> Invoke(GetExperimentInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetExperimentResult> getExperiment(GetExperimentArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: google-native:aiplatform/v1beta1:getExperiment
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ExperimentId string
    Location string
    TensorboardId string
    Project string
    ExperimentId string
    Location string
    TensorboardId string
    Project string
    experimentId String
    location String
    tensorboardId String
    project String
    experimentId string
    location string
    tensorboardId string
    project string
    experimentId String
    location String
    tensorboardId String
    project String

    getExperiment Result

    The following output properties are available:

    CreateTime string
    Timestamp when this TensorboardExperiment was created.
    Description string
    Description of this TensorboardExperiment.
    DisplayName string
    User provided name of this TensorboardExperiment.
    Etag string
    Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    Labels Dictionary<string, string>
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with aiplatform.googleapis.com/ and are immutable. The following system labels exist for each Dataset: * aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title.
    Name string
    Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    Source string
    Immutable. Source of the TensorboardExperiment. Example: a custom training job.
    UpdateTime string
    Timestamp when this TensorboardExperiment was last updated.
    CreateTime string
    Timestamp when this TensorboardExperiment was created.
    Description string
    Description of this TensorboardExperiment.
    DisplayName string
    User provided name of this TensorboardExperiment.
    Etag string
    Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    Labels map[string]string
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with aiplatform.googleapis.com/ and are immutable. The following system labels exist for each Dataset: * aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title.
    Name string
    Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    Source string
    Immutable. Source of the TensorboardExperiment. Example: a custom training job.
    UpdateTime string
    Timestamp when this TensorboardExperiment was last updated.
    createTime String
    Timestamp when this TensorboardExperiment was created.
    description String
    Description of this TensorboardExperiment.
    displayName String
    User provided name of this TensorboardExperiment.
    etag String
    Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    labels Map<String,String>
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with aiplatform.googleapis.com/ and are immutable. The following system labels exist for each Dataset: * aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title.
    name String
    Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    source String
    Immutable. Source of the TensorboardExperiment. Example: a custom training job.
    updateTime String
    Timestamp when this TensorboardExperiment was last updated.
    createTime string
    Timestamp when this TensorboardExperiment was created.
    description string
    Description of this TensorboardExperiment.
    displayName string
    User provided name of this TensorboardExperiment.
    etag string
    Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    labels {[key: string]: string}
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with aiplatform.googleapis.com/ and are immutable. The following system labels exist for each Dataset: * aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title.
    name string
    Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    source string
    Immutable. Source of the TensorboardExperiment. Example: a custom training job.
    updateTime string
    Timestamp when this TensorboardExperiment was last updated.
    create_time str
    Timestamp when this TensorboardExperiment was created.
    description str
    Description of this TensorboardExperiment.
    display_name str
    User provided name of this TensorboardExperiment.
    etag str
    Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    labels Mapping[str, str]
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with aiplatform.googleapis.com/ and are immutable. The following system labels exist for each Dataset: * aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title.
    name str
    Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    source str
    Immutable. Source of the TensorboardExperiment. Example: a custom training job.
    update_time str
    Timestamp when this TensorboardExperiment was last updated.
    createTime String
    Timestamp when this TensorboardExperiment was created.
    description String
    Description of this TensorboardExperiment.
    displayName String
    User provided name of this TensorboardExperiment.
    etag String
    Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    labels Map<String>
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with aiplatform.googleapis.com/ and are immutable. The following system labels exist for each Dataset: * aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title.
    name String
    Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    source String
    Immutable. Source of the TensorboardExperiment. Example: a custom training job.
    updateTime String
    Timestamp when this TensorboardExperiment was last updated.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    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