DpEndpointSummary

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

Bases: object

The endpoint summary object.

Attributes

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

Methods

__init__(**kwargs) Initializes a new DpEndpointSummary 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 DpEndpointSummary. 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 DpEndpointSummary. This constant has a value of “PUBLIC_END_POINT”

__init__(**kwargs)

Initializes a new DpEndpointSummary 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 DpEndpointSummary. Allowed values for this property are: “PRIVATE_END_POINT”, “PUBLIC_END_POINT”
  • key (str) – The value to assign to the key property of this DpEndpointSummary.
  • model_version (str) – The value to assign to the model_version property of this DpEndpointSummary.
  • parent_ref (oci.data_connectivity.models.ParentReference) – The value to assign to the parent_ref property of this DpEndpointSummary.
  • name (str) – The value to assign to the name property of this DpEndpointSummary.
  • description (str) – The value to assign to the description property of this DpEndpointSummary.
  • object_version (int) – The value to assign to the object_version property of this DpEndpointSummary.
  • object_status (int) – The value to assign to the object_status property of this DpEndpointSummary.
  • identifier (str) – The value to assign to the identifier property of this DpEndpointSummary.
  • data_assets (list[oci.data_connectivity.models.DataAsset]) – The value to assign to the data_assets property of this DpEndpointSummary.
data_assets

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

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

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

Returns:The description of this DpEndpointSummary.
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 DpEndpointSummary. 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 DpEndpointSummary.
Return type:str
key

Gets the key of this DpEndpointSummary. 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 DpEndpointSummary.
Return type:str
model_type

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

Allowed values for this property are: “PRIVATE_END_POINT”, “PUBLIC_END_POINT”

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

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

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

Gets the name of this DpEndpointSummary. 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 DpEndpointSummary.
Return type:str
object_status

Gets the object_status of this DpEndpointSummary. 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 DpEndpointSummary.
Return type:int
object_version

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

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

Gets the parent_ref of this DpEndpointSummary.

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