ApiSchemaObjectStorageInputLocation

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

Bases: ApiSchemaInputLocation

The details of OCI Object Storage object location for Api schema.

Attributes:

API_SCHEMA_INPUT_LOCATION_TYPE_INLINE

A constant which can be used with the api_schema_input_location_type property of a ApiSchemaInputLocation.

API_SCHEMA_INPUT_LOCATION_TYPE_OBJECT_STORAGE_LOCATION

A constant which can be used with the api_schema_input_location_type property of a ApiSchemaInputLocation.

api_schema_input_location_type

[Required] Gets the api_schema_input_location_type of this ApiSchemaInputLocation.

bucket_name

[Required] Gets the bucket_name of this ApiSchemaObjectStorageInputLocation.

namespace_name

[Required] Gets the namespace_name of this ApiSchemaObjectStorageInputLocation.

object_name

[Required] Gets the object_name of this ApiSchemaObjectStorageInputLocation.

Methods:

__init__(**kwargs)

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

API_SCHEMA_INPUT_LOCATION_TYPE_INLINE = 'INLINE'

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

API_SCHEMA_INPUT_LOCATION_TYPE_OBJECT_STORAGE_LOCATION = 'OBJECT_STORAGE_LOCATION'

A constant which can be used with the api_schema_input_location_type property of a ApiSchemaInputLocation. This constant has a value of “OBJECT_STORAGE_LOCATION”

__init__(**kwargs)

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

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

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

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

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

property api_schema_input_location_type

[Required] Gets the api_schema_input_location_type of this ApiSchemaInputLocation. Type of Api Schema InputLocation.

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

Returns

The api_schema_input_location_type of this ApiSchemaInputLocation.

Return type

str

property bucket_name

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

Returns

The bucket_name of this ApiSchemaObjectStorageInputLocation.

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 ApiSchemaObjectStorageInputLocation. The namespace name of an object.

Returns

The namespace_name of this ApiSchemaObjectStorageInputLocation.

Return type

str

property object_name

[Required] Gets the object_name of this ApiSchemaObjectStorageInputLocation. The location/name of object.

Returns

The object_name of this ApiSchemaObjectStorageInputLocation.

Return type

str