BipReadAttributes

class oci.data_integration.models.BipReadAttributes(**kwargs)

Bases: oci.data_integration.models.abstract_read_attribute.AbstractReadAttribute

Properties to configure reading from a FUSION_APP BIP data asset / connection.

Attributes

MODEL_TYPE_BICC_READ_ATTRIBUTE str(object=’’) -> str
MODEL_TYPE_BIP_READ_ATTRIBUTE str(object=’’) -> str
MODEL_TYPE_ORACLEREADATTRIBUTE str(object=’’) -> str
MODEL_TYPE_ORACLE_READ_ATTRIBUTE str(object=’’) -> str
bucket_schema Gets the bucket_schema of this BipReadAttributes.
custom_parameters Gets the custom_parameters of this BipReadAttributes.
fetch_next_rows_parameter Gets the fetch_next_rows_parameter of this BipReadAttributes.
fetch_size Gets the fetch_size of this BipReadAttributes.
model_type [Required] Gets the model_type of this AbstractReadAttribute.
offset_parameter Gets the offset_parameter of this BipReadAttributes.
row_limit Gets the row_limit of this BipReadAttributes.
staging_connection Gets the staging_connection of this BipReadAttributes.
staging_data_asset Gets the staging_data_asset of this BipReadAttributes.

Methods

__init__(**kwargs) Initializes a new BipReadAttributes 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.
MODEL_TYPE_BICC_READ_ATTRIBUTE = 'BICC_READ_ATTRIBUTE'
MODEL_TYPE_BIP_READ_ATTRIBUTE = 'BIP_READ_ATTRIBUTE'
MODEL_TYPE_ORACLEREADATTRIBUTE = 'ORACLEREADATTRIBUTE'
MODEL_TYPE_ORACLE_READ_ATTRIBUTE = 'ORACLE_READ_ATTRIBUTE'
__init__(**kwargs)

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

Parameters:
  • model_type (str) – The value to assign to the model_type property of this BipReadAttributes. Allowed values for this property are: “ORACLEREADATTRIBUTE”, “ORACLE_READ_ATTRIBUTE”, “BICC_READ_ATTRIBUTE”, “BIP_READ_ATTRIBUTE”
  • fetch_size (int) – The value to assign to the fetch_size property of this BipReadAttributes.
  • row_limit (int) – The value to assign to the row_limit property of this BipReadAttributes.
  • offset_parameter (str) – The value to assign to the offset_parameter property of this BipReadAttributes.
  • fetch_next_rows_parameter (str) – The value to assign to the fetch_next_rows_parameter property of this BipReadAttributes.
  • custom_parameters (list[oci.data_integration.models.BipReportParameterValue]) – The value to assign to the custom_parameters property of this BipReadAttributes.
  • staging_data_asset (oci.data_integration.models.DataAssetSummaryFromObjectStorage) – The value to assign to the staging_data_asset property of this BipReadAttributes.
  • staging_connection (oci.data_integration.models.ConnectionSummaryFromObjectStorage) – The value to assign to the staging_connection property of this BipReadAttributes.
  • bucket_schema (oci.data_integration.models.Schema) – The value to assign to the bucket_schema property of this BipReadAttributes.
bucket_schema

Gets the bucket_schema of this BipReadAttributes.

Returns:The bucket_schema of this BipReadAttributes.
Return type:oci.data_integration.models.Schema
custom_parameters

Gets the custom_parameters of this BipReadAttributes. An array of custom BIP report parameters and their values.

Returns:The custom_parameters of this BipReadAttributes.
Return type:list[oci.data_integration.models.BipReportParameterValue]
fetch_next_rows_parameter

Gets the fetch_next_rows_parameter of this BipReadAttributes. Name of BIP report parameter to control the start of the chunk

Returns:The fetch_next_rows_parameter of this BipReadAttributes.
Return type:str
fetch_size

Gets the fetch_size of this BipReadAttributes. The fetch size for reading.

Returns:The fetch_size of this BipReadAttributes.
Return type:int
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.

model_type

[Required] Gets the model_type of this AbstractReadAttribute. The type of the abstract read attribute.

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

Returns:The model_type of this AbstractReadAttribute.
Return type:str
offset_parameter

Gets the offset_parameter of this BipReadAttributes. Name of BIP report parameter to control the start of the chunk

Returns:The offset_parameter of this BipReadAttributes.
Return type:str
row_limit

Gets the row_limit of this BipReadAttributes. The maximum number of rows to read.

Returns:The row_limit of this BipReadAttributes.
Return type:int
staging_connection

Gets the staging_connection of this BipReadAttributes.

Returns:The staging_connection of this BipReadAttributes.
Return type:oci.data_integration.models.ConnectionSummaryFromObjectStorage
staging_data_asset

Gets the staging_data_asset of this BipReadAttributes.

Returns:The staging_data_asset of this BipReadAttributes.
Return type:oci.data_integration.models.DataAssetSummaryFromObjectStorage