DpEndpoint

class oci.data_connectivity.models.DpEndpoint(**kwargs)

Bases: object

The endpoint for a data asset.

Attributes

MODEL_TYPE_PRIVATE_END_POINT A constant which can be used with the model_type property of a DpEndpoint.
MODEL_TYPE_PUBLIC_END_POINT A constant which can be used with the model_type property of a DpEndpoint.
data_assets Gets the data_assets of this DpEndpoint.
description Gets the description of this DpEndpoint.
identifier Gets the identifier of this DpEndpoint.
key Gets the key of this DpEndpoint.
model_type [Required] Gets the model_type of this DpEndpoint.
model_version Gets the model_version of this DpEndpoint.
name Gets the name of this DpEndpoint.
object_status Gets the object_status of this DpEndpoint.
object_version Gets the object_version of this DpEndpoint.
parent_ref Gets the parent_ref of this DpEndpoint.

Methods

__init__(**kwargs) Initializes a new DpEndpoint 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_PRIVATE_END_POINT = 'PRIVATE_END_POINT'

A constant which can be used with the model_type property of a DpEndpoint. This constant has a value of “PRIVATE_END_POINT”

MODEL_TYPE_PUBLIC_END_POINT = 'PUBLIC_END_POINT'

A constant which can be used with the model_type property of a DpEndpoint. This constant has a value of “PUBLIC_END_POINT”

__init__(**kwargs)

Initializes a new DpEndpoint object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

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 DpEndpoint. Allowed values for this property are: “PRIVATE_END_POINT”, “PUBLIC_END_POINT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • key (str) – The value to assign to the key property of this DpEndpoint.
  • model_version (str) – The value to assign to the model_version property of this DpEndpoint.
  • parent_ref (oci.data_connectivity.models.ParentReference) – The value to assign to the parent_ref property of this DpEndpoint.
  • name (str) – The value to assign to the name property of this DpEndpoint.
  • description (str) – The value to assign to the description property of this DpEndpoint.
  • object_version (int) – The value to assign to the object_version property of this DpEndpoint.
  • object_status (int) – The value to assign to the object_status property of this DpEndpoint.
  • identifier (str) – The value to assign to the identifier property of this DpEndpoint.
  • data_assets (list[oci.data_connectivity.models.DataAsset]) – The value to assign to the data_assets property of this DpEndpoint.
data_assets

Gets the data_assets of this DpEndpoint. List of data assets which belongs to this endpoint

Returns:The data_assets of this DpEndpoint.
Return type:list[oci.data_connectivity.models.DataAsset]
description

Gets the description of this DpEndpoint. User-defined description for the endpoint.

Returns:The description of this DpEndpoint.
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.

identifier

Gets the identifier of this DpEndpoint. Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.

Returns:The identifier of this DpEndpoint.
Return type:str
key

Gets the key of this DpEndpoint. Generated key that can be used in API calls to identify endpoint. On scenarios where reference to the endpoint is needed, a value can be passed in create.

Returns:The key of this DpEndpoint.
Return type:str
model_type

[Required] Gets the model_type of this DpEndpoint. The type of the endpoint.

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

Returns:The model_type of this DpEndpoint.
Return type:str
model_version

Gets the model_version of this DpEndpoint. The model version of an object.

Returns:The model_version of this DpEndpoint.
Return type:str
name

Gets the name of this DpEndpoint. Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Returns:The name of this DpEndpoint.
Return type:str
object_status

Gets the object_status of this DpEndpoint. The status of an object that can be set to value 1 for shallow references across objects, other values reserved.

Returns:The object_status of this DpEndpoint.
Return type:int
object_version

Gets the object_version of this DpEndpoint. The version of the object that is used to track changes in the object instance.

Returns:The object_version of this DpEndpoint.
Return type:int
parent_ref

Gets the parent_ref of this DpEndpoint.

Returns:The parent_ref of this DpEndpoint.
Return type:oci.data_connectivity.models.ParentReference