oci 2.138.0__py3-none-any.whl → 2.138.1__py3-none-any.whl

oci/golden_gate/models/connection_summary.py

@@ -235,6 +235,10 @@ class ConnectionSummary(object):
             The value to assign to the locks property of this ConnectionSummary.
         :type locks: list[oci.golden_gate.models.ResourceLock]
 
+        :param does_use_secret_ids:
+            The value to assign to the does_use_secret_ids property of this ConnectionSummary.
+        :type does_use_secret_ids: bool
+
         """
         self.swagger_types = {
             'connection_type': 'str',
@@ -255,7 +259,8 @@ class ConnectionSummary(object):
             'nsg_ids': 'list[str]',
             'subnet_id': 'str',
             'routing_method': 'str',
-            'locks': 'list[ResourceLock]'
+            'locks': 'list[ResourceLock]',
+            'does_use_secret_ids': 'bool'
         }
 
         self.attribute_map = {
@@ -277,7 +282,8 @@ class ConnectionSummary(object):
             'nsg_ids': 'nsgIds',
             'subnet_id': 'subnetId',
             'routing_method': 'routingMethod',
-            'locks': 'locks'
+            'locks': 'locks',
+            'does_use_secret_ids': 'doesUseSecretIds'
         }
 
         self._connection_type = None
@@ -299,6 +305,7 @@ class ConnectionSummary(object):
         self._subnet_id = None
         self._routing_method = None
         self._locks = None
+        self._does_use_secret_ids = None
 
     @staticmethod
     def get_subtype(object_dictionary):
@@ -914,6 +921,30 @@ class ConnectionSummary(object):
         """
         self._locks = locks
 
+    @property
+    def does_use_secret_ids(self):
+        """
+        Gets the does_use_secret_ids of this ConnectionSummary.
+        Indicates that sensitive attributes are provided via Secrets.
+
+
+        :return: The does_use_secret_ids of this ConnectionSummary.
+        :rtype: bool
+        """
+        return self._does_use_secret_ids
+
+    @does_use_secret_ids.setter
+    def does_use_secret_ids(self, does_use_secret_ids):
+        """
+        Sets the does_use_secret_ids of this ConnectionSummary.
+        Indicates that sensitive attributes are provided via Secrets.
+
+
+        :param does_use_secret_ids: The does_use_secret_ids of this ConnectionSummary.
+        :type: bool
+        """
+        self._does_use_secret_ids = does_use_secret_ids
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/golden_gate/models/create_amazon_kinesis_connection_details.py

@@ -71,6 +71,10 @@ class CreateAmazonKinesisConnectionDetails(CreateConnectionDetails):
             Allowed values for this property are: "SHARED_SERVICE_ENDPOINT", "SHARED_DEPLOYMENT_ENDPOINT", "DEDICATED_ENDPOINT"
         :type routing_method: str
 
+        :param does_use_secret_ids:
+            The value to assign to the does_use_secret_ids property of this CreateAmazonKinesisConnectionDetails.
+        :type does_use_secret_ids: bool
+
         :param technology_type:
             The value to assign to the technology_type property of this CreateAmazonKinesisConnectionDetails.
         :type technology_type: str
@@ -83,6 +87,10 @@ class CreateAmazonKinesisConnectionDetails(CreateConnectionDetails):
             The value to assign to the secret_access_key property of this CreateAmazonKinesisConnectionDetails.
         :type secret_access_key: str
 
+        :param secret_access_key_secret_id:
+            The value to assign to the secret_access_key_secret_id property of this CreateAmazonKinesisConnectionDetails.
+        :type secret_access_key_secret_id: str
+
         """
         self.swagger_types = {
             'connection_type': 'str',
@@ -97,9 +105,11 @@ class CreateAmazonKinesisConnectionDetails(CreateConnectionDetails):
             'nsg_ids': 'list[str]',
             'subnet_id': 'str',
             'routing_method': 'str',
+            'does_use_secret_ids': 'bool',
             'technology_type': 'str',
             'access_key_id': 'str',
-            'secret_access_key': 'str'
+            'secret_access_key': 'str',
+            'secret_access_key_secret_id': 'str'
         }
 
         self.attribute_map = {
@@ -115,9 +125,11 @@ class CreateAmazonKinesisConnectionDetails(CreateConnectionDetails):
             'nsg_ids': 'nsgIds',
             'subnet_id': 'subnetId',
             'routing_method': 'routingMethod',
+            'does_use_secret_ids': 'doesUseSecretIds',
             'technology_type': 'technologyType',
             'access_key_id': 'accessKeyId',
-            'secret_access_key': 'secretAccessKey'
+            'secret_access_key': 'secretAccessKey',
+            'secret_access_key_secret_id': 'secretAccessKeySecretId'
         }
 
         self._connection_type = None
@@ -132,9 +144,11 @@ class CreateAmazonKinesisConnectionDetails(CreateConnectionDetails):
         self._nsg_ids = None
         self._subnet_id = None
         self._routing_method = None
+        self._does_use_secret_ids = None
         self._technology_type = None
         self._access_key_id = None
         self._secret_access_key = None
+        self._secret_access_key_secret_id = None
         self._connection_type = 'AMAZON_KINESIS'
 
     @property
@@ -188,7 +202,7 @@ class CreateAmazonKinesisConnectionDetails(CreateConnectionDetails):
     @property
     def secret_access_key(self):
         """
-        **[Required]** Gets the secret_access_key of this CreateAmazonKinesisConnectionDetails.
+        Gets the secret_access_key of this CreateAmazonKinesisConnectionDetails.
         Secret access key to access the Amazon Kinesis.
 
 
@@ -209,6 +223,36 @@ class CreateAmazonKinesisConnectionDetails(CreateConnectionDetails):
         """
         self._secret_access_key = secret_access_key
 
+    @property
+    def secret_access_key_secret_id(self):
+        """
+        Gets the secret_access_key_secret_id of this CreateAmazonKinesisConnectionDetails.
+        The `OCID`__ of the Secret where the secret access key is stored.
+        Note: When provided, 'secretAccessKey' field must not be provided.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :return: The secret_access_key_secret_id of this CreateAmazonKinesisConnectionDetails.
+        :rtype: str
+        """
+        return self._secret_access_key_secret_id
+
+    @secret_access_key_secret_id.setter
+    def secret_access_key_secret_id(self, secret_access_key_secret_id):
+        """
+        Sets the secret_access_key_secret_id of this CreateAmazonKinesisConnectionDetails.
+        The `OCID`__ of the Secret where the secret access key is stored.
+        Note: When provided, 'secretAccessKey' field must not be provided.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :param secret_access_key_secret_id: The secret_access_key_secret_id of this CreateAmazonKinesisConnectionDetails.
+        :type: str
+        """
+        self._secret_access_key_secret_id = secret_access_key_secret_id
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/golden_gate/models/create_amazon_redshift_connection_details.py

@@ -71,6 +71,10 @@ class CreateAmazonRedshiftConnectionDetails(CreateConnectionDetails):
             Allowed values for this property are: "SHARED_SERVICE_ENDPOINT", "SHARED_DEPLOYMENT_ENDPOINT", "DEDICATED_ENDPOINT"
         :type routing_method: str
 
+        :param does_use_secret_ids:
+            The value to assign to the does_use_secret_ids property of this CreateAmazonRedshiftConnectionDetails.
+        :type does_use_secret_ids: bool
+
         :param technology_type:
             The value to assign to the technology_type property of this CreateAmazonRedshiftConnectionDetails.
         :type technology_type: str
@@ -87,6 +91,10 @@ class CreateAmazonRedshiftConnectionDetails(CreateConnectionDetails):
             The value to assign to the password property of this CreateAmazonRedshiftConnectionDetails.
         :type password: str
 
+        :param password_secret_id:
+            The value to assign to the password_secret_id property of this CreateAmazonRedshiftConnectionDetails.
+        :type password_secret_id: str
+
         """
         self.swagger_types = {
             'connection_type': 'str',
@@ -101,10 +109,12 @@ class CreateAmazonRedshiftConnectionDetails(CreateConnectionDetails):
             'nsg_ids': 'list[str]',
             'subnet_id': 'str',
             'routing_method': 'str',
+            'does_use_secret_ids': 'bool',
             'technology_type': 'str',
             'connection_url': 'str',
             'username': 'str',
-            'password': 'str'
+            'password': 'str',
+            'password_secret_id': 'str'
         }
 
         self.attribute_map = {
@@ -120,10 +130,12 @@ class CreateAmazonRedshiftConnectionDetails(CreateConnectionDetails):
             'nsg_ids': 'nsgIds',
             'subnet_id': 'subnetId',
             'routing_method': 'routingMethod',
+            'does_use_secret_ids': 'doesUseSecretIds',
             'technology_type': 'technologyType',
             'connection_url': 'connectionUrl',
             'username': 'username',
-            'password': 'password'
+            'password': 'password',
+            'password_secret_id': 'passwordSecretId'
         }
 
         self._connection_type = None
@@ -138,10 +150,12 @@ class CreateAmazonRedshiftConnectionDetails(CreateConnectionDetails):
         self._nsg_ids = None
         self._subnet_id = None
         self._routing_method = None
+        self._does_use_secret_ids = None
         self._technology_type = None
         self._connection_url = None
         self._username = None
         self._password = None
+        self._password_secret_id = None
         self._connection_type = 'AMAZON_REDSHIFT'
 
     @property
@@ -225,7 +239,7 @@ class CreateAmazonRedshiftConnectionDetails(CreateConnectionDetails):
     @property
     def password(self):
         """
-        **[Required]** Gets the password of this CreateAmazonRedshiftConnectionDetails.
+        Gets the password of this CreateAmazonRedshiftConnectionDetails.
         The password Oracle GoldenGate uses to connect the associated system of the given technology.
         It must conform to the specific security requirements including length, case sensitivity, and so on.
 
@@ -248,6 +262,42 @@ class CreateAmazonRedshiftConnectionDetails(CreateConnectionDetails):
         """
         self._password = password
 
+    @property
+    def password_secret_id(self):
+        """
+        Gets the password_secret_id of this CreateAmazonRedshiftConnectionDetails.
+        The `OCID`__ of the Secret where the password is stored.
+        The password Oracle GoldenGate uses to connect the associated system of the given technology.
+        It must conform to the specific security requirements including length, case sensitivity, and so on.
+        If secretId is used plaintext field must not be provided.
+        Note: When provided, 'password' field must not be provided.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :return: The password_secret_id of this CreateAmazonRedshiftConnectionDetails.
+        :rtype: str
+        """
+        return self._password_secret_id
+
+    @password_secret_id.setter
+    def password_secret_id(self, password_secret_id):
+        """
+        Sets the password_secret_id of this CreateAmazonRedshiftConnectionDetails.
+        The `OCID`__ of the Secret where the password is stored.
+        The password Oracle GoldenGate uses to connect the associated system of the given technology.
+        It must conform to the specific security requirements including length, case sensitivity, and so on.
+        If secretId is used plaintext field must not be provided.
+        Note: When provided, 'password' field must not be provided.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :param password_secret_id: The password_secret_id of this CreateAmazonRedshiftConnectionDetails.
+        :type: str
+        """
+        self._password_secret_id = password_secret_id
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/golden_gate/models/create_amazon_s3_connection_details.py

@@ -71,6 +71,10 @@ class CreateAmazonS3ConnectionDetails(CreateConnectionDetails):
             Allowed values for this property are: "SHARED_SERVICE_ENDPOINT", "SHARED_DEPLOYMENT_ENDPOINT", "DEDICATED_ENDPOINT"
         :type routing_method: str
 
+        :param does_use_secret_ids:
+            The value to assign to the does_use_secret_ids property of this CreateAmazonS3ConnectionDetails.
+        :type does_use_secret_ids: bool
+
         :param technology_type:
             The value to assign to the technology_type property of this CreateAmazonS3ConnectionDetails.
         :type technology_type: str
@@ -83,6 +87,10 @@ class CreateAmazonS3ConnectionDetails(CreateConnectionDetails):
             The value to assign to the secret_access_key property of this CreateAmazonS3ConnectionDetails.
         :type secret_access_key: str
 
+        :param secret_access_key_secret_id:
+            The value to assign to the secret_access_key_secret_id property of this CreateAmazonS3ConnectionDetails.
+        :type secret_access_key_secret_id: str
+
         """
         self.swagger_types = {
             'connection_type': 'str',
@@ -97,9 +105,11 @@ class CreateAmazonS3ConnectionDetails(CreateConnectionDetails):
             'nsg_ids': 'list[str]',
             'subnet_id': 'str',
             'routing_method': 'str',
+            'does_use_secret_ids': 'bool',
             'technology_type': 'str',
             'access_key_id': 'str',
-            'secret_access_key': 'str'
+            'secret_access_key': 'str',
+            'secret_access_key_secret_id': 'str'
         }
 
         self.attribute_map = {
@@ -115,9 +125,11 @@ class CreateAmazonS3ConnectionDetails(CreateConnectionDetails):
             'nsg_ids': 'nsgIds',
             'subnet_id': 'subnetId',
             'routing_method': 'routingMethod',
+            'does_use_secret_ids': 'doesUseSecretIds',
             'technology_type': 'technologyType',
             'access_key_id': 'accessKeyId',
-            'secret_access_key': 'secretAccessKey'
+            'secret_access_key': 'secretAccessKey',
+            'secret_access_key_secret_id': 'secretAccessKeySecretId'
         }
 
         self._connection_type = None
@@ -132,9 +144,11 @@ class CreateAmazonS3ConnectionDetails(CreateConnectionDetails):
         self._nsg_ids = None
         self._subnet_id = None
         self._routing_method = None
+        self._does_use_secret_ids = None
         self._technology_type = None
         self._access_key_id = None
         self._secret_access_key = None
+        self._secret_access_key_secret_id = None
         self._connection_type = 'AMAZON_S3'
 
     @property
@@ -190,7 +204,7 @@ class CreateAmazonS3ConnectionDetails(CreateConnectionDetails):
     @property
     def secret_access_key(self):
         """
-        **[Required]** Gets the secret_access_key of this CreateAmazonS3ConnectionDetails.
+        Gets the secret_access_key of this CreateAmazonS3ConnectionDetails.
         Secret access key to access the Amazon S3 bucket.
         e.g.: \"this-is-not-the-secret\"
 
@@ -213,6 +227,36 @@ class CreateAmazonS3ConnectionDetails(CreateConnectionDetails):
         """
         self._secret_access_key = secret_access_key
 
+    @property
+    def secret_access_key_secret_id(self):
+        """
+        Gets the secret_access_key_secret_id of this CreateAmazonS3ConnectionDetails.
+        The `OCID`__ of the Secret where the Secret Access Key is stored.
+        Note: When provided, 'secretAccessKey' field must not be provided.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :return: The secret_access_key_secret_id of this CreateAmazonS3ConnectionDetails.
+        :rtype: str
+        """
+        return self._secret_access_key_secret_id
+
+    @secret_access_key_secret_id.setter
+    def secret_access_key_secret_id(self, secret_access_key_secret_id):
+        """
+        Sets the secret_access_key_secret_id of this CreateAmazonS3ConnectionDetails.
+        The `OCID`__ of the Secret where the Secret Access Key is stored.
+        Note: When provided, 'secretAccessKey' field must not be provided.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :param secret_access_key_secret_id: The secret_access_key_secret_id of this CreateAmazonS3ConnectionDetails.
+        :type: str
+        """
+        self._secret_access_key_secret_id = secret_access_key_secret_id
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/golden_gate/models/create_azure_data_lake_storage_connection_details.py

@@ -71,6 +71,10 @@ class CreateAzureDataLakeStorageConnectionDetails(CreateConnectionDetails):
             Allowed values for this property are: "SHARED_SERVICE_ENDPOINT", "SHARED_DEPLOYMENT_ENDPOINT", "DEDICATED_ENDPOINT"
         :type routing_method: str
 
+        :param does_use_secret_ids:
+            The value to assign to the does_use_secret_ids property of this CreateAzureDataLakeStorageConnectionDetails.
+        :type does_use_secret_ids: bool
+
         :param technology_type:
             The value to assign to the technology_type property of this CreateAzureDataLakeStorageConnectionDetails.
         :type technology_type: str
@@ -87,10 +91,18 @@ class CreateAzureDataLakeStorageConnectionDetails(CreateConnectionDetails):
             The value to assign to the account_key property of this CreateAzureDataLakeStorageConnectionDetails.
         :type account_key: str
 
+        :param account_key_secret_id:
+            The value to assign to the account_key_secret_id property of this CreateAzureDataLakeStorageConnectionDetails.
+        :type account_key_secret_id: str
+
         :param sas_token:
             The value to assign to the sas_token property of this CreateAzureDataLakeStorageConnectionDetails.
         :type sas_token: str
 
+        :param sas_token_secret_id:
+            The value to assign to the sas_token_secret_id property of this CreateAzureDataLakeStorageConnectionDetails.
+        :type sas_token_secret_id: str
+
         :param azure_tenant_id:
             The value to assign to the azure_tenant_id property of this CreateAzureDataLakeStorageConnectionDetails.
         :type azure_tenant_id: str
@@ -103,6 +115,10 @@ class CreateAzureDataLakeStorageConnectionDetails(CreateConnectionDetails):
             The value to assign to the client_secret property of this CreateAzureDataLakeStorageConnectionDetails.
         :type client_secret: str
 
+        :param client_secret_secret_id:
+            The value to assign to the client_secret_secret_id property of this CreateAzureDataLakeStorageConnectionDetails.
+        :type client_secret_secret_id: str
+
         :param endpoint:
             The value to assign to the endpoint property of this CreateAzureDataLakeStorageConnectionDetails.
         :type endpoint: str
@@ -121,14 +137,18 @@ class CreateAzureDataLakeStorageConnectionDetails(CreateConnectionDetails):
             'nsg_ids': 'list[str]',
             'subnet_id': 'str',
             'routing_method': 'str',
+            'does_use_secret_ids': 'bool',
             'technology_type': 'str',
             'authentication_type': 'str',
             'account_name': 'str',
             'account_key': 'str',
+            'account_key_secret_id': 'str',
             'sas_token': 'str',
+            'sas_token_secret_id': 'str',
             'azure_tenant_id': 'str',
             'client_id': 'str',
             'client_secret': 'str',
+            'client_secret_secret_id': 'str',
             'endpoint': 'str'
         }
 
@@ -145,14 +165,18 @@ class CreateAzureDataLakeStorageConnectionDetails(CreateConnectionDetails):
             'nsg_ids': 'nsgIds',
             'subnet_id': 'subnetId',
             'routing_method': 'routingMethod',
+            'does_use_secret_ids': 'doesUseSecretIds',
             'technology_type': 'technologyType',
             'authentication_type': 'authenticationType',
             'account_name': 'accountName',
             'account_key': 'accountKey',
+            'account_key_secret_id': 'accountKeySecretId',
             'sas_token': 'sasToken',
+            'sas_token_secret_id': 'sasTokenSecretId',
             'azure_tenant_id': 'azureTenantId',
             'client_id': 'clientId',
             'client_secret': 'clientSecret',
+            'client_secret_secret_id': 'clientSecretSecretId',
             'endpoint': 'endpoint'
         }
 
@@ -168,14 +192,18 @@ class CreateAzureDataLakeStorageConnectionDetails(CreateConnectionDetails):
         self._nsg_ids = None
         self._subnet_id = None
         self._routing_method = None
+        self._does_use_secret_ids = None
         self._technology_type = None
         self._authentication_type = None
         self._account_name = None
         self._account_key = None
+        self._account_key_secret_id = None
         self._sas_token = None
+        self._sas_token_secret_id = None
         self._azure_tenant_id = None
         self._client_id = None
         self._client_secret = None
+        self._client_secret_secret_id = None
         self._endpoint = None
         self._connection_type = 'AZURE_DATA_LAKE_STORAGE'
 
@@ -277,6 +305,36 @@ class CreateAzureDataLakeStorageConnectionDetails(CreateConnectionDetails):
         """
         self._account_key = account_key
 
+    @property
+    def account_key_secret_id(self):
+        """
+        Gets the account_key_secret_id of this CreateAzureDataLakeStorageConnectionDetails.
+        The `OCID`__ of the Secret where the account key is stored.
+        Note: When provided, 'accountKey' field must not be provided.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :return: The account_key_secret_id of this CreateAzureDataLakeStorageConnectionDetails.
+        :rtype: str
+        """
+        return self._account_key_secret_id
+
+    @account_key_secret_id.setter
+    def account_key_secret_id(self, account_key_secret_id):
+        """
+        Sets the account_key_secret_id of this CreateAzureDataLakeStorageConnectionDetails.
+        The `OCID`__ of the Secret where the account key is stored.
+        Note: When provided, 'accountKey' field must not be provided.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :param account_key_secret_id: The account_key_secret_id of this CreateAzureDataLakeStorageConnectionDetails.
+        :type: str
+        """
+        self._account_key_secret_id = account_key_secret_id
+
     @property
     def sas_token(self):
         """
@@ -305,6 +363,36 @@ class CreateAzureDataLakeStorageConnectionDetails(CreateConnectionDetails):
         """
         self._sas_token = sas_token
 
+    @property
+    def sas_token_secret_id(self):
+        """
+        Gets the sas_token_secret_id of this CreateAzureDataLakeStorageConnectionDetails.
+        The `OCID`__ of the Secret where the sas token is stored.
+        Note: When provided, 'sasToken' field must not be provided.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :return: The sas_token_secret_id of this CreateAzureDataLakeStorageConnectionDetails.
+        :rtype: str
+        """
+        return self._sas_token_secret_id
+
+    @sas_token_secret_id.setter
+    def sas_token_secret_id(self, sas_token_secret_id):
+        """
+        Sets the sas_token_secret_id of this CreateAzureDataLakeStorageConnectionDetails.
+        The `OCID`__ of the Secret where the sas token is stored.
+        Note: When provided, 'sasToken' field must not be provided.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :param sas_token_secret_id: The sas_token_secret_id of this CreateAzureDataLakeStorageConnectionDetails.
+        :type: str
+        """
+        self._sas_token_secret_id = sas_token_secret_id
+
     @property
     def azure_tenant_id(self):
         """
@@ -383,6 +471,36 @@ class CreateAzureDataLakeStorageConnectionDetails(CreateConnectionDetails):
         """
         self._client_secret = client_secret
 
+    @property
+    def client_secret_secret_id(self):
+        """
+        Gets the client_secret_secret_id of this CreateAzureDataLakeStorageConnectionDetails.
+        The `OCID`__ of the Secret where the client secret is stored.
+        Note: When provided, 'clientSecret' field must not be provided.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :return: The client_secret_secret_id of this CreateAzureDataLakeStorageConnectionDetails.
+        :rtype: str
+        """
+        return self._client_secret_secret_id
+
+    @client_secret_secret_id.setter
+    def client_secret_secret_id(self, client_secret_secret_id):
+        """
+        Sets the client_secret_secret_id of this CreateAzureDataLakeStorageConnectionDetails.
+        The `OCID`__ of the Secret where the client secret is stored.
+        Note: When provided, 'clientSecret' field must not be provided.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :param client_secret_secret_id: The client_secret_secret_id of this CreateAzureDataLakeStorageConnectionDetails.
+        :type: str
+        """
+        self._client_secret_secret_id = client_secret_secret_id
+
     @property
     def endpoint(self):
         """