Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. aiplatform
  5. aiplatform/v1beta1
  6. TimeSeries

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
pulumi/pulumi-google-native

google-native.aiplatform/v1beta1.TimeSeries

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
pulumi/pulumi-google-native

Creates a TensorboardTimeSeries. Auto-naming is currently not supported for this resource.

Create TimeSeries Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new TimeSeries(name: string, args: TimeSeriesArgs, opts?: CustomResourceOptions);
@overload
def TimeSeries(resource_name: str,
               args: TimeSeriesArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def TimeSeries(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               display_name: Optional[str] = None,
               experiment_id: Optional[str] = None,
               run_id: Optional[str] = None,
               tensorboard_id: Optional[str] = None,
               value_type: Optional[TimeSeriesValueType] = None,
               description: Optional[str] = None,
               etag: Optional[str] = None,
               location: Optional[str] = None,
               plugin_data: Optional[str] = None,
               plugin_name: Optional[str] = None,
               project: Optional[str] = None,
               tensorboard_time_series_id: Optional[str] = None)
func NewTimeSeries(ctx *Context, name string, args TimeSeriesArgs, opts ...ResourceOption) (*TimeSeries, error)
public TimeSeries(string name, TimeSeriesArgs args, CustomResourceOptions? opts = null)
public TimeSeries(String name, TimeSeriesArgs args)
public TimeSeries(String name, TimeSeriesArgs args, CustomResourceOptions options)

type: google-native:aiplatform/v1beta1:TimeSeries
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TimeSeriesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. TimeSeriesArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. TimeSeriesArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TimeSeriesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TimeSeriesArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var google_nativeTimeSeriesResource = new GoogleNative.Aiplatform.V1Beta1.TimeSeries("google-nativeTimeSeriesResource", new()
{
    DisplayName = "string",
    ExperimentId = "string",
    RunId = "string",
    TensorboardId = "string",
    ValueType = GoogleNative.Aiplatform.V1Beta1.TimeSeriesValueType.ValueTypeUnspecified,
    Description = "string",
    Etag = "string",
    Location = "string",
    PluginData = "string",
    PluginName = "string",
    Project = "string",
    TensorboardTimeSeriesId = "string",
});
Copy
example, err := aiplatformv1beta1.NewTimeSeries(ctx, "google-nativeTimeSeriesResource", &aiplatformv1beta1.TimeSeriesArgs{
	DisplayName:             pulumi.String("string"),
	ExperimentId:            pulumi.String("string"),
	RunId:                   pulumi.String("string"),
	TensorboardId:           pulumi.String("string"),
	ValueType:               aiplatformv1beta1.TimeSeriesValueTypeValueTypeUnspecified,
	Description:             pulumi.String("string"),
	Etag:                    pulumi.String("string"),
	Location:                pulumi.String("string"),
	PluginData:              pulumi.String("string"),
	PluginName:              pulumi.String("string"),
	Project:                 pulumi.String("string"),
	TensorboardTimeSeriesId: pulumi.String("string"),
})
Copy
var google_nativeTimeSeriesResource = new TimeSeries("google-nativeTimeSeriesResource", TimeSeriesArgs.builder()
    .displayName("string")
    .experimentId("string")
    .runId("string")
    .tensorboardId("string")
    .valueType("VALUE_TYPE_UNSPECIFIED")
    .description("string")
    .etag("string")
    .location("string")
    .pluginData("string")
    .pluginName("string")
    .project("string")
    .tensorboardTimeSeriesId("string")
    .build());
Copy
google_native_time_series_resource = google_native.aiplatform.v1beta1.TimeSeries("google-nativeTimeSeriesResource",
    display_name="string",
    experiment_id="string",
    run_id="string",
    tensorboard_id="string",
    value_type=google_native.aiplatform.v1beta1.TimeSeriesValueType.VALUE_TYPE_UNSPECIFIED,
    description="string",
    etag="string",
    location="string",
    plugin_data="string",
    plugin_name="string",
    project="string",
    tensorboard_time_series_id="string")
Copy
const google_nativeTimeSeriesResource = new google_native.aiplatform.v1beta1.TimeSeries("google-nativeTimeSeriesResource", {
    displayName: "string",
    experimentId: "string",
    runId: "string",
    tensorboardId: "string",
    valueType: google_native.aiplatform.v1beta1.TimeSeriesValueType.ValueTypeUnspecified,
    description: "string",
    etag: "string",
    location: "string",
    pluginData: "string",
    pluginName: "string",
    project: "string",
    tensorboardTimeSeriesId: "string",
});
Copy
type: google-native:aiplatform/v1beta1:TimeSeries
properties:
    description: string
    displayName: string
    etag: string
    experimentId: string
    location: string
    pluginData: string
    pluginName: string
    project: string
    runId: string
    tensorboardId: string
    tensorboardTimeSeriesId: string
    valueType: VALUE_TYPE_UNSPECIFIED
Copy

TimeSeries Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The TimeSeries resource accepts the following input properties:

DisplayName This property is required. string
User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).
ExperimentId
This property is required.
Changes to this property will trigger replacement.
string
RunId
This property is required.
Changes to this property will trigger replacement.
string
TensorboardId
This property is required.
Changes to this property will trigger replacement.
string
ValueType This property is required. Pulumi.GoogleNative.Aiplatform.V1Beta1.TimeSeriesValueType
Immutable. Type of TensorboardTimeSeries value.
Description string
Description of this TensorboardTimeSeries.
Etag string
Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Location Changes to this property will trigger replacement. string
PluginData string
Data of the current plugin, with the size limited to 65KB.
PluginName string
Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob
Project Changes to this property will trigger replacement. string
TensorboardTimeSeriesId string
Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match "a-z0-9{0, 127}"
DisplayName This property is required. string
User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).
ExperimentId
This property is required.
Changes to this property will trigger replacement.
string
RunId
This property is required.
Changes to this property will trigger replacement.
string
TensorboardId
This property is required.
Changes to this property will trigger replacement.
string
ValueType This property is required. TimeSeriesValueType
Immutable. Type of TensorboardTimeSeries value.
Description string
Description of this TensorboardTimeSeries.
Etag string
Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Location Changes to this property will trigger replacement. string
PluginData string
Data of the current plugin, with the size limited to 65KB.
PluginName string
Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob
Project Changes to this property will trigger replacement. string
TensorboardTimeSeriesId string
Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match "a-z0-9{0, 127}"
displayName This property is required. String
User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).
experimentId
This property is required.
Changes to this property will trigger replacement.
String
runId
This property is required.
Changes to this property will trigger replacement.
String
tensorboardId
This property is required.
Changes to this property will trigger replacement.
String
valueType This property is required. TimeSeriesValueType
Immutable. Type of TensorboardTimeSeries value.
description String
Description of this TensorboardTimeSeries.
etag String
Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
location Changes to this property will trigger replacement. String
pluginData String
Data of the current plugin, with the size limited to 65KB.
pluginName String
Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob
project Changes to this property will trigger replacement. String
tensorboardTimeSeriesId String
Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match "a-z0-9{0, 127}"
displayName This property is required. string
User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).
experimentId
This property is required.
Changes to this property will trigger replacement.
string
runId
This property is required.
Changes to this property will trigger replacement.
string
tensorboardId
This property is required.
Changes to this property will trigger replacement.
string
valueType This property is required. TimeSeriesValueType
Immutable. Type of TensorboardTimeSeries value.
description string
Description of this TensorboardTimeSeries.
etag string
Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
location Changes to this property will trigger replacement. string
pluginData string
Data of the current plugin, with the size limited to 65KB.
pluginName string
Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob
project Changes to this property will trigger replacement. string
tensorboardTimeSeriesId string
Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match "a-z0-9{0, 127}"
display_name This property is required. str
User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).
experiment_id
This property is required.
Changes to this property will trigger replacement.
str
run_id
This property is required.
Changes to this property will trigger replacement.
str
tensorboard_id
This property is required.
Changes to this property will trigger replacement.
str
value_type This property is required. TimeSeriesValueType
Immutable. Type of TensorboardTimeSeries value.
description str
Description of this TensorboardTimeSeries.
etag str
Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
location Changes to this property will trigger replacement. str
plugin_data str
Data of the current plugin, with the size limited to 65KB.
plugin_name str
Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob
project Changes to this property will trigger replacement. str
tensorboard_time_series_id str
Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match "a-z0-9{0, 127}"
displayName This property is required. String
User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).
experimentId
This property is required.
Changes to this property will trigger replacement.
String
runId
This property is required.
Changes to this property will trigger replacement.
String
tensorboardId
This property is required.
Changes to this property will trigger replacement.
String
valueType This property is required. "VALUE_TYPE_UNSPECIFIED" | "SCALAR" | "TENSOR" | "BLOB_SEQUENCE"
Immutable. Type of TensorboardTimeSeries value.
description String
Description of this TensorboardTimeSeries.
etag String
Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
location Changes to this property will trigger replacement. String
pluginData String
Data of the current plugin, with the size limited to 65KB.
pluginName String
Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob
project Changes to this property will trigger replacement. String
tensorboardTimeSeriesId String
Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match "a-z0-9{0, 127}"

Outputs

All input properties are implicitly available as output properties. Additionally, the TimeSeries resource produces the following output properties:

CreateTime string
Timestamp when this TensorboardTimeSeries was created.
Id string
The provider-assigned unique ID for this managed resource.
Metadata Pulumi.GoogleNative.Aiplatform.V1Beta1.Outputs.GoogleCloudAiplatformV1beta1TensorboardTimeSeriesMetadataResponse
Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.
Name string
Name of the TensorboardTimeSeries.
UpdateTime string
Timestamp when this TensorboardTimeSeries was last updated.
CreateTime string
Timestamp when this TensorboardTimeSeries was created.
Id string
The provider-assigned unique ID for this managed resource.
Metadata GoogleCloudAiplatformV1beta1TensorboardTimeSeriesMetadataResponse
Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.
Name string
Name of the TensorboardTimeSeries.
UpdateTime string
Timestamp when this TensorboardTimeSeries was last updated.
createTime String
Timestamp when this TensorboardTimeSeries was created.
id String
The provider-assigned unique ID for this managed resource.
metadata GoogleCloudAiplatformV1beta1TensorboardTimeSeriesMetadataResponse
Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.
name String
Name of the TensorboardTimeSeries.
updateTime String
Timestamp when this TensorboardTimeSeries was last updated.
createTime string
Timestamp when this TensorboardTimeSeries was created.
id string
The provider-assigned unique ID for this managed resource.
metadata GoogleCloudAiplatformV1beta1TensorboardTimeSeriesMetadataResponse
Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.
name string
Name of the TensorboardTimeSeries.
updateTime string
Timestamp when this TensorboardTimeSeries was last updated.
create_time str
Timestamp when this TensorboardTimeSeries was created.
id str
The provider-assigned unique ID for this managed resource.
metadata GoogleCloudAiplatformV1beta1TensorboardTimeSeriesMetadataResponse
Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.
name str
Name of the TensorboardTimeSeries.
update_time str
Timestamp when this TensorboardTimeSeries was last updated.
createTime String
Timestamp when this TensorboardTimeSeries was created.
id String
The provider-assigned unique ID for this managed resource.
metadata Property Map
Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.
name String
Name of the TensorboardTimeSeries.
updateTime String
Timestamp when this TensorboardTimeSeries was last updated.

Supporting Types

GoogleCloudAiplatformV1beta1TensorboardTimeSeriesMetadataResponse
, GoogleCloudAiplatformV1beta1TensorboardTimeSeriesMetadataResponseArgs

MaxBlobSequenceLength This property is required. string
The largest blob sequence length (number of blobs) of all data points in this time series, if its ValueType is BLOB_SEQUENCE.
MaxStep This property is required. string
Max step index of all data points within a TensorboardTimeSeries.
MaxWallTime This property is required. string
Max wall clock timestamp of all data points within a TensorboardTimeSeries.
MaxBlobSequenceLength This property is required. string
The largest blob sequence length (number of blobs) of all data points in this time series, if its ValueType is BLOB_SEQUENCE.
MaxStep This property is required. string
Max step index of all data points within a TensorboardTimeSeries.
MaxWallTime This property is required. string
Max wall clock timestamp of all data points within a TensorboardTimeSeries.
maxBlobSequenceLength This property is required. String
The largest blob sequence length (number of blobs) of all data points in this time series, if its ValueType is BLOB_SEQUENCE.
maxStep This property is required. String
Max step index of all data points within a TensorboardTimeSeries.
maxWallTime This property is required. String
Max wall clock timestamp of all data points within a TensorboardTimeSeries.
maxBlobSequenceLength This property is required. string
The largest blob sequence length (number of blobs) of all data points in this time series, if its ValueType is BLOB_SEQUENCE.
maxStep This property is required. string
Max step index of all data points within a TensorboardTimeSeries.
maxWallTime This property is required. string
Max wall clock timestamp of all data points within a TensorboardTimeSeries.
max_blob_sequence_length This property is required. str
The largest blob sequence length (number of blobs) of all data points in this time series, if its ValueType is BLOB_SEQUENCE.
max_step This property is required. str
Max step index of all data points within a TensorboardTimeSeries.
max_wall_time This property is required. str
Max wall clock timestamp of all data points within a TensorboardTimeSeries.
maxBlobSequenceLength This property is required. String
The largest blob sequence length (number of blobs) of all data points in this time series, if its ValueType is BLOB_SEQUENCE.
maxStep This property is required. String
Max step index of all data points within a TensorboardTimeSeries.
maxWallTime This property is required. String
Max wall clock timestamp of all data points within a TensorboardTimeSeries.

TimeSeriesValueType
, TimeSeriesValueTypeArgs

ValueTypeUnspecified
VALUE_TYPE_UNSPECIFIEDThe value type is unspecified.
Scalar
SCALARUsed for TensorboardTimeSeries that is a list of scalars. E.g. accuracy of a model over epochs/time.
Tensor
TENSORUsed for TensorboardTimeSeries that is a list of tensors. E.g. histograms of weights of layer in a model over epoch/time.
BlobSequence
BLOB_SEQUENCEUsed for TensorboardTimeSeries that is a list of blob sequences. E.g. set of sample images with labels over epochs/time.
TimeSeriesValueTypeValueTypeUnspecified
VALUE_TYPE_UNSPECIFIEDThe value type is unspecified.
TimeSeriesValueTypeScalar
SCALARUsed for TensorboardTimeSeries that is a list of scalars. E.g. accuracy of a model over epochs/time.
TimeSeriesValueTypeTensor
TENSORUsed for TensorboardTimeSeries that is a list of tensors. E.g. histograms of weights of layer in a model over epoch/time.
TimeSeriesValueTypeBlobSequence
BLOB_SEQUENCEUsed for TensorboardTimeSeries that is a list of blob sequences. E.g. set of sample images with labels over epochs/time.
ValueTypeUnspecified
VALUE_TYPE_UNSPECIFIEDThe value type is unspecified.
Scalar
SCALARUsed for TensorboardTimeSeries that is a list of scalars. E.g. accuracy of a model over epochs/time.
Tensor
TENSORUsed for TensorboardTimeSeries that is a list of tensors. E.g. histograms of weights of layer in a model over epoch/time.
BlobSequence
BLOB_SEQUENCEUsed for TensorboardTimeSeries that is a list of blob sequences. E.g. set of sample images with labels over epochs/time.
ValueTypeUnspecified
VALUE_TYPE_UNSPECIFIEDThe value type is unspecified.
Scalar
SCALARUsed for TensorboardTimeSeries that is a list of scalars. E.g. accuracy of a model over epochs/time.
Tensor
TENSORUsed for TensorboardTimeSeries that is a list of tensors. E.g. histograms of weights of layer in a model over epoch/time.
BlobSequence
BLOB_SEQUENCEUsed for TensorboardTimeSeries that is a list of blob sequences. E.g. set of sample images with labels over epochs/time.
VALUE_TYPE_UNSPECIFIED
VALUE_TYPE_UNSPECIFIEDThe value type is unspecified.
SCALAR
SCALARUsed for TensorboardTimeSeries that is a list of scalars. E.g. accuracy of a model over epochs/time.
TENSOR
TENSORUsed for TensorboardTimeSeries that is a list of tensors. E.g. histograms of weights of layer in a model over epoch/time.
BLOB_SEQUENCE
BLOB_SEQUENCEUsed for TensorboardTimeSeries that is a list of blob sequences. E.g. set of sample images with labels over epochs/time.
"VALUE_TYPE_UNSPECIFIED"
VALUE_TYPE_UNSPECIFIEDThe value type is unspecified.
"SCALAR"
SCALARUsed for TensorboardTimeSeries that is a list of scalars. E.g. accuracy of a model over epochs/time.
"TENSOR"
TENSORUsed for TensorboardTimeSeries that is a list of tensors. E.g. histograms of weights of layer in a model over epoch/time.
"BLOB_SEQUENCE"
BLOB_SEQUENCEUsed for TensorboardTimeSeries that is a list of blob sequences. E.g. set of sample images with labels over epochs/time.

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
pulumi/pulumi-google-native