Console
    Contact Us Start free

    Google Cloud Ai Platform V1 Client - Class Dataset (0.37.1)

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

    A collection of DataItems and Annotations on them.

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

    Namespace

    Google \ Cloud \ AIPlatform \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ name
    string

    Output only. The resource name of the Dataset.

    ↳ display_name
    string

    Required. The user-defined name of the Dataset. The name can be up to 128 characters long and can consist of any UTF-8 characters.

    ↳ description
    string

    The description of the Dataset.

    ↳ metadata_schema_uri
    string

    Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.

    ↳ metadata
    Google\Protobuf\Value

    Required. Additional information about the Dataset.

    ↳ data_item_count
    int|string

    Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.

    ↳ create_time
    Google\Protobuf\Timestamp

    Output only. Timestamp when this Dataset was created.

    ↳ update_time
    Google\Protobuf\Timestamp

    Output only. Timestamp when this Dataset was last updated.

    ↳ etag
    string

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

    ↳ labels
    array| Google\Protobuf\Internal\MapField

    The labels with user-defined metadata to organize your Datasets. 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 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. Following system labels exist for each Dataset: * "aiplatform.googleapis.com/dataset_metadata_schema": output only, its value is the metadata_schema's title.

    ↳ saved_queries
    array< Google\Cloud\AIPlatform\V1\SavedQuery >

    All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count . In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.

    ↳ encryption_spec
    Google\Cloud\AIPlatform\V1\EncryptionSpec

    Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key.

    ↳ metadata_artifact
    string

    Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact} .

    getName

    Output only. The resource name of the Dataset.

    Returns
    Type
    Description
    string

    setName

    Output only. The resource name of the Dataset.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDisplayName

    Required. The user-defined name of the Dataset.

    The name can be up to 128 characters long and can consist of any UTF-8 characters.

    Returns
    Type
    Description
    string

    setDisplayName

    Required. The user-defined name of the Dataset.

    The name can be up to 128 characters long and can consist of any UTF-8 characters.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDescription

    The description of the Dataset.

    Returns
    Type
    Description
    string

    setDescription

    The description of the Dataset.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getMetadataSchemaUri

    Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.

    Returns
    Type
    Description
    string

    setMetadataSchemaUri

    Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getMetadata

    Required. Additional information about the Dataset.

    Returns
    Type
    Description
    Google\Protobuf\Value |null

    hasMetadata

    clearMetadata

    setMetadata

    Required. Additional information about the Dataset.

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

    getDataItemCount

    Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.

    Returns
    Type
    Description
    int|string

    setDataItemCount

    Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.

    Parameter
    Name
    Description
    var
    int|string
    Returns
    Type
    Description
    $this

    getCreateTime

    Output only. Timestamp when this Dataset was created.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasCreateTime

    clearCreateTime

    setCreateTime

    Output only. Timestamp when this Dataset was created.

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

    getUpdateTime

    Output only. Timestamp when this Dataset was last updated.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasUpdateTime

    clearUpdateTime

    setUpdateTime

    Output only. Timestamp when this Dataset was last updated.

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

    getEtag

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

    Returns
    Type
    Description
    string

    setEtag

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getLabels

    The labels with user-defined metadata to organize your Datasets.

    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 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. Following system labels exist for each Dataset:

    • "aiplatform.googleapis.com/dataset_metadata_schema": output only, its value is the metadata_schema's title.
    Returns
    Type
    Description
    Google\Protobuf\Internal\MapField

    setLabels

    The labels with user-defined metadata to organize your Datasets.

    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 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. Following system labels exist for each Dataset:

    • "aiplatform.googleapis.com/dataset_metadata_schema": output only, its value is the metadata_schema's title.
    Parameter
    Name
    Description
    var
    array| Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $this

    getSavedQueries

    All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count .

    In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setSavedQueries

    All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count .

    In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.

    Parameter
    Name
    Description
    var
    array< Google\Cloud\AIPlatform\V1\SavedQuery >
    Returns
    Type
    Description
    $this

    getEncryptionSpec

    Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key.

    Returns
    Type
    Description
    Google\Cloud\AIPlatform\V1\EncryptionSpec |null

    hasEncryptionSpec

    clearEncryptionSpec

    setEncryptionSpec

    Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key.

    Parameter
    Name
    Description
    var
    Google\Cloud\AIPlatform\V1\EncryptionSpec
    Returns
    Type
    Description
    $this

    getMetadataArtifact

    Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact} .

    Returns
    Type
    Description
    string

    setMetadataArtifact

    Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact} .

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: