Console
    Contact Us Start free

    Google Cloud Ai Platform V1 Client - Class TensorboardTimeSeries (0.10.0)

    Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class TensorboardTimeSeries.

    TensorboardTimeSeries maps to times series produced in training runs

    Generated from protobuf message google.cloud.aiplatform.v1.TensorboardTimeSeries

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ name
    string

    Output only. Name of the TensorboardTimeSeries.

    ↳ display_name
    string

    Required. User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).

    ↳ description
    string

    Description of this TensorboardTimeSeries.

    ↳ value_type
    int

    Required. Immutable. Type of TensorboardTimeSeries value.

    ↳ create_time
    Google\Protobuf\Timestamp

    Output only. Timestamp when this TensorboardTimeSeries was created.

    ↳ update_time
    Google\Protobuf\Timestamp

    Output only. Timestamp when this TensorboardTimeSeries was last updated.

    ↳ etag
    string

    Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

    ↳ plugin_name
    string

    Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob

    ↳ plugin_data
    string

    Data of the current plugin, with the size limited to 65KB.

    ↳ metadata
    Google\Cloud\AIPlatform\V1\TensorboardTimeSeries\Metadata

    Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.

    getName

    Output only. Name of the TensorboardTimeSeries.

    Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    string

    setName

    Output only. Name of the TensorboardTimeSeries.

    Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDisplayName

    Required. User provided name of this TensorboardTimeSeries.

    This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).

    Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

    Returns
    Type
    Description
    string

    setDisplayName

    Required. User provided name of this TensorboardTimeSeries.

    This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).

    Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDescription

    Description of this TensorboardTimeSeries.

    Generated from protobuf field string description = 3;

    Returns
    Type
    Description
    string

    setDescription

    Description of this TensorboardTimeSeries.

    Generated from protobuf field string description = 3;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getValueType

    Required. Immutable. Type of TensorboardTimeSeries value.

    Generated from protobuf field .google.cloud.aiplatform.v1.TensorboardTimeSeries.ValueType value_type = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

    Returns
    Type
    Description
    int

    setValueType

    Required. Immutable. Type of TensorboardTimeSeries value.

    Generated from protobuf field .google.cloud.aiplatform.v1.TensorboardTimeSeries.ValueType value_type = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getCreateTime

    Output only. Timestamp when this TensorboardTimeSeries was created.

    Generated from protobuf field .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    Google\Protobuf\Timestamp|null

    hasCreateTime

    clearCreateTime

    setCreateTime

    Output only. Timestamp when this TensorboardTimeSeries was created.

    Generated from protobuf field .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getUpdateTime

    Output only. Timestamp when this TensorboardTimeSeries was last updated.

    Generated from protobuf field .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    Google\Protobuf\Timestamp|null

    hasUpdateTime

    clearUpdateTime

    setUpdateTime

    Output only. Timestamp when this TensorboardTimeSeries was last updated.

    Generated from protobuf field .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getEtag

    Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

    Generated from protobuf field string etag = 7;

    Returns
    Type
    Description
    string

    setEtag

    Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

    Generated from protobuf field string etag = 7;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getPluginName

    Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob

    Generated from protobuf field string plugin_name = 8 [(.google.api.field_behavior) = IMMUTABLE];

    Returns
    Type
    Description
    string

    setPluginName

    Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob

    Generated from protobuf field string plugin_name = 8 [(.google.api.field_behavior) = IMMUTABLE];

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getPluginData

    Data of the current plugin, with the size limited to 65KB.

    Generated from protobuf field bytes plugin_data = 9;

    Returns
    Type
    Description
    string

    setPluginData

    Data of the current plugin, with the size limited to 65KB.

    Generated from protobuf field bytes plugin_data = 9;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getMetadata

    Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.

    Generated from protobuf field .google.cloud.aiplatform.v1.TensorboardTimeSeries.Metadata metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    Google\Cloud\AIPlatform\V1\TensorboardTimeSeries\Metadata |null

    hasMetadata

    clearMetadata

    setMetadata

    Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.

    Generated from protobuf field .google.cloud.aiplatform.v1.TensorboardTimeSeries.Metadata metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    Google\Cloud\AIPlatform\V1\TensorboardTimeSeries\Metadata
    Returns
    Type
    Description
    $this
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: