ObjectStorageImageDetails

class oci.ai_vision.models.ObjectStorageImageDetails(**kwargs)

Bases: ImageDetails

The image residing in OCI Object Storage.

Attributes:

SOURCE_INLINE

A constant which can be used with the source property of a ImageDetails.

SOURCE_OBJECT_STORAGE

A constant which can be used with the source property of a ImageDetails.

bucket_name

[Required] Gets the bucket_name of this ObjectStorageImageDetails.

namespace_name

[Required] Gets the namespace_name of this ObjectStorageImageDetails.

object_name

[Required] Gets the object_name of this ObjectStorageImageDetails.

source

[Required] Gets the source of this ImageDetails.

Methods:

__init__(**kwargs)

Initializes a new ObjectStorageImageDetails 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.

SOURCE_INLINE = 'INLINE'

A constant which can be used with the source property of a ImageDetails. This constant has a value of “INLINE”

SOURCE_OBJECT_STORAGE = 'OBJECT_STORAGE'

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

__init__(**kwargs)

Initializes a new ObjectStorageImageDetails object with values from keyword arguments. The default value of the source 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
  • source (str) – The value to assign to the source property of this ObjectStorageImageDetails. Allowed values for this property are: “INLINE”, “OBJECT_STORAGE”

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

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

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

property bucket_name

[Required] Gets the bucket_name of this ObjectStorageImageDetails. The Object Storage bucket name.

Returns

The bucket_name of this ObjectStorageImageDetails.

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 ObjectStorageImageDetails. The Object Storage namespace.

Returns

The namespace_name of this ObjectStorageImageDetails.

Return type

str

property object_name

[Required] Gets the object_name of this ObjectStorageImageDetails. The Object Storage object name.

Returns

The object_name of this ObjectStorageImageDetails.

Return type

str

property source

[Required] Gets the source of this ImageDetails. The location of the image data. The allowed values are: - INLINE: The data is included directly in the request payload. - OBJECT_STORAGE: The image is in OCI Object Storage.

Allowed values for this property are: “INLINE”, “OBJECT_STORAGE”

Returns

The source of this ImageDetails.

Return type

str