ObjectStorageInputLocation

class oci.generative_ai_agent.models.ObjectStorageInputLocation(**kwargs)

Bases: InputLocation

The details of OCI Object Storage object.

Attributes:

INPUT_LOCATION_TYPE_INLINE

A constant which can be used with the input_location_type property of a InputLocation.

INPUT_LOCATION_TYPE_OBJECT_STORAGE_PREFIX

A constant which can be used with the input_location_type property of a InputLocation.

bucket_name

[Required] Gets the bucket_name of this ObjectStorageInputLocation.

input_location_type

[Required] Gets the input_location_type of this InputLocation.

namespace_name

[Required] Gets the namespace_name of this ObjectStorageInputLocation.

prefix

Gets the prefix of this ObjectStorageInputLocation.

Methods:

__init__(**kwargs)

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

INPUT_LOCATION_TYPE_INLINE = 'INLINE'

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

INPUT_LOCATION_TYPE_OBJECT_STORAGE_PREFIX = 'OBJECT_STORAGE_PREFIX'

A constant which can be used with the input_location_type property of a InputLocation. This constant has a value of “OBJECT_STORAGE_PREFIX”

__init__(**kwargs)

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

Parameters
  • input_location_type (str) – The value to assign to the input_location_type property of this ObjectStorageInputLocation. Allowed values for this property are: “INLINE”, “OBJECT_STORAGE_PREFIX”

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

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

  • prefix (str) – The value to assign to the prefix property of this ObjectStorageInputLocation.

property bucket_name

[Required] Gets the bucket_name of this ObjectStorageInputLocation. The bucket name of an object.

Returns

The bucket_name of this ObjectStorageInputLocation.

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 input_location_type

[Required] Gets the input_location_type of this InputLocation. Type of InputLocation.

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

Returns

The input_location_type of this InputLocation.

Return type

str

property namespace_name

[Required] Gets the namespace_name of this ObjectStorageInputLocation. The namespace name of an object.

Returns

The namespace_name of this ObjectStorageInputLocation.

Return type

str

property prefix

Gets the prefix of this ObjectStorageInputLocation. The prefix of file object(s) or folder prefix.

Returns

The prefix of this ObjectStorageInputLocation.

Return type

str