1. Packages
  2. Google Cloud Native
  3. API Docs
  4. aiplatform
  5. aiplatform/v1
  6. getTensorboard

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/v1.getTensorboard

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

    Using getTensorboard

    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 getTensorboard(args: GetTensorboardArgs, opts?: InvokeOptions): Promise<GetTensorboardResult>
    function getTensorboardOutput(args: GetTensorboardOutputArgs, opts?: InvokeOptions): Output<GetTensorboardResult>
    def get_tensorboard(location: Optional[str] = None,
                        project: Optional[str] = None,
                        tensorboard_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetTensorboardResult
    def get_tensorboard_output(location: Optional[pulumi.Input[str]] = None,
                        project: Optional[pulumi.Input[str]] = None,
                        tensorboard_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetTensorboardResult]
    func LookupTensorboard(ctx *Context, args *LookupTensorboardArgs, opts ...InvokeOption) (*LookupTensorboardResult, error)
    func LookupTensorboardOutput(ctx *Context, args *LookupTensorboardOutputArgs, opts ...InvokeOption) LookupTensorboardResultOutput

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

    public static class GetTensorboard 
    {
        public static Task<GetTensorboardResult> InvokeAsync(GetTensorboardArgs args, InvokeOptions? opts = null)
        public static Output<GetTensorboardResult> Invoke(GetTensorboardInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetTensorboardResult> getTensorboard(GetTensorboardArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: google-native:aiplatform/v1:getTensorboard
      arguments:
        # arguments dictionary

    The following arguments are supported:

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

    getTensorboard Result

    The following output properties are available:

    BlobStoragePathPrefix string
    Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'.
    CreateTime string
    Timestamp when this Tensorboard was created.
    Description string
    Description of this Tensorboard.
    DisplayName string
    User provided name of this Tensorboard.
    EncryptionSpec Pulumi.GoogleNative.Aiplatform.V1.Outputs.GoogleCloudAiplatformV1EncryptionSpecResponse
    Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.
    Etag string
    Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    IsDefault bool
    Used to indicate if the TensorBoard instance is the default one. Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default.
    Labels Dictionary<string, string>
    The labels with user-defined metadata to organize your Tensorboards. Label keys and values can be no 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 Tensorboard (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.
    Name string
    Name of the Tensorboard. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
    RunCount int
    The number of Runs stored in this Tensorboard.
    UpdateTime string
    Timestamp when this Tensorboard was last updated.
    BlobStoragePathPrefix string
    Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'.
    CreateTime string
    Timestamp when this Tensorboard was created.
    Description string
    Description of this Tensorboard.
    DisplayName string
    User provided name of this Tensorboard.
    EncryptionSpec GoogleCloudAiplatformV1EncryptionSpecResponse
    Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.
    Etag string
    Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    IsDefault bool
    Used to indicate if the TensorBoard instance is the default one. Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default.
    Labels map[string]string
    The labels with user-defined metadata to organize your Tensorboards. Label keys and values can be no 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 Tensorboard (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.
    Name string
    Name of the Tensorboard. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
    RunCount int
    The number of Runs stored in this Tensorboard.
    UpdateTime string
    Timestamp when this Tensorboard was last updated.
    blobStoragePathPrefix String
    Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'.
    createTime String
    Timestamp when this Tensorboard was created.
    description String
    Description of this Tensorboard.
    displayName String
    User provided name of this Tensorboard.
    encryptionSpec GoogleCloudAiplatformV1EncryptionSpecResponse
    Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.
    etag String
    Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    isDefault Boolean
    Used to indicate if the TensorBoard instance is the default one. Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default.
    labels Map<String,String>
    The labels with user-defined metadata to organize your Tensorboards. Label keys and values can be no 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 Tensorboard (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.
    name String
    Name of the Tensorboard. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
    runCount Integer
    The number of Runs stored in this Tensorboard.
    updateTime String
    Timestamp when this Tensorboard was last updated.
    blobStoragePathPrefix string
    Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'.
    createTime string
    Timestamp when this Tensorboard was created.
    description string
    Description of this Tensorboard.
    displayName string
    User provided name of this Tensorboard.
    encryptionSpec GoogleCloudAiplatformV1EncryptionSpecResponse
    Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.
    etag string
    Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    isDefault boolean
    Used to indicate if the TensorBoard instance is the default one. Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default.
    labels {[key: string]: string}
    The labels with user-defined metadata to organize your Tensorboards. Label keys and values can be no 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 Tensorboard (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.
    name string
    Name of the Tensorboard. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
    runCount number
    The number of Runs stored in this Tensorboard.
    updateTime string
    Timestamp when this Tensorboard was last updated.
    blob_storage_path_prefix str
    Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'.
    create_time str
    Timestamp when this Tensorboard was created.
    description str
    Description of this Tensorboard.
    display_name str
    User provided name of this Tensorboard.
    encryption_spec GoogleCloudAiplatformV1EncryptionSpecResponse
    Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.
    etag str
    Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    is_default bool
    Used to indicate if the TensorBoard instance is the default one. Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default.
    labels Mapping[str, str]
    The labels with user-defined metadata to organize your Tensorboards. Label keys and values can be no 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 Tensorboard (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.
    name str
    Name of the Tensorboard. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
    run_count int
    The number of Runs stored in this Tensorboard.
    update_time str
    Timestamp when this Tensorboard was last updated.
    blobStoragePathPrefix String
    Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'.
    createTime String
    Timestamp when this Tensorboard was created.
    description String
    Description of this Tensorboard.
    displayName String
    User provided name of this Tensorboard.
    encryptionSpec Property Map
    Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.
    etag String
    Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    isDefault Boolean
    Used to indicate if the TensorBoard instance is the default one. Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default.
    labels Map<String>
    The labels with user-defined metadata to organize your Tensorboards. Label keys and values can be no 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 Tensorboard (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.
    name String
    Name of the Tensorboard. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
    runCount Number
    The number of Runs stored in this Tensorboard.
    updateTime String
    Timestamp when this Tensorboard was last updated.

    Supporting Types

    GoogleCloudAiplatformV1EncryptionSpecResponse

    KmsKeyName string
    The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
    KmsKeyName string
    The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
    kmsKeyName String
    The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
    kmsKeyName string
    The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
    kms_key_name str
    The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
    kmsKeyName String
    The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.

    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