ObjectStorageDataset

class oci.ai_document.models.ObjectStorageDataset(**kwargs)

Bases: Dataset

The dataset that resides in Object Storage.

Attributes:

DATASET_TYPE_DATA_SCIENCE_LABELING

A constant which can be used with the dataset_type property of a Dataset.

DATASET_TYPE_OBJECT_STORAGE

A constant which can be used with the dataset_type property of a Dataset.

bucket_name

[Required] Gets the bucket_name of this ObjectStorageDataset.

dataset_type

[Required] Gets the dataset_type of this Dataset.

namespace_name

[Required] Gets the namespace_name of this ObjectStorageDataset.

object_name

[Required] Gets the object_name of this ObjectStorageDataset.

Methods:

__init__(**kwargs)

Initializes a new ObjectStorageDataset object with values from keyword arguments.

get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

DATASET_TYPE_DATA_SCIENCE_LABELING = 'DATA_SCIENCE_LABELING'

A constant which can be used with the dataset_type property of a Dataset. This constant has a value of “DATA_SCIENCE_LABELING”

DATASET_TYPE_OBJECT_STORAGE = 'OBJECT_STORAGE'

A constant which can be used with the dataset_type property of a Dataset. This constant has a value of “OBJECT_STORAGE”

__init__(**kwargs)

Initializes a new ObjectStorageDataset object with values from keyword arguments. The default value of the dataset_type attribute of this class is OBJECT_STORAGE and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • dataset_type (str) – The value to assign to the dataset_type property of this ObjectStorageDataset. Allowed values for this property are: “DATA_SCIENCE_LABELING”, “OBJECT_STORAGE”

  • namespace_name (str) – The value to assign to the namespace_name property of this ObjectStorageDataset.

  • bucket_name (str) – The value to assign to the bucket_name property of this ObjectStorageDataset.

  • object_name (str) – The value to assign to the object_name property of this ObjectStorageDataset.

property bucket_name

[Required] Gets the bucket_name of this ObjectStorageDataset. The name of the Object Storage bucket that contains the input data file.

Returns

The bucket_name of this ObjectStorageDataset.

Return type

str

property dataset_type

[Required] Gets the dataset_type of this Dataset. The dataset type, based on where it is stored.

Allowed values for this property are: “DATA_SCIENCE_LABELING”, “OBJECT_STORAGE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The dataset_type of this Dataset.

Return type

str

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property namespace_name

[Required] Gets the namespace_name of this ObjectStorageDataset. The namespace name of the Object Storage bucket that contains the input data file.

Returns

The namespace_name of this ObjectStorageDataset.

Return type

str

property object_name

[Required] Gets the object_name of this ObjectStorageDataset. The object name of the input data file.

Returns

The object_name of this ObjectStorageDataset.

Return type

str