Update to python SDK docs: 14212788787

This commit is contained in:
developer-relations-sp
2025-04-02 06:13:45 +00:00
parent cab77035bd
commit 6355808626
20 changed files with 7374 additions and 7319 deletions

View File

@@ -26,7 +26,7 @@ Name | Type | Description | Notes
from sailpoint.beta.models.account_usage import AccountUsage
account_usage = AccountUsage(
var_date='Thu Apr 20 20:00:00 EDT 2023',
var_date='Fri Apr 21 00:00:00 UTC 2023',
count=10
)

View File

@@ -56,8 +56,8 @@ data={description=Auditing},
approval_status='APPROVED',
comment='approved',
completion_date='2020-03-24T11:11:41.139-05:00',
start_date='Mon Mar 23 20:00:00 EDT 2020',
end_date='Wed Mar 24 20:00:00 EDT 2021',
start_date='Tue Mar 24 00:00:00 UTC 2020',
end_date='Thu Mar 25 00:00:00 UTC 2021',
modified='2020-03-24T11:11:41.139-05:00',
created='2020-03-24T11:11:41.139-05:00'
)

View File

@@ -26,7 +26,7 @@ Name | Type | Description | Notes
from sailpoint.beta.models.source_usage import SourceUsage
source_usage = SourceUsage(
var_date='Thu Apr 20 20:00:00 EDT 2023',
var_date='Fri Apr 21 00:00:00 UTC 2023',
count=10.45
)

View File

@@ -284,7 +284,7 @@ Param Type | Name | Data Type | Required | Description
Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq*
Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq*
### Return type
[**List[ManagedCluster]**](../models/managed-cluster)
@@ -317,7 +317,7 @@ with ApiClient(configuration) as api_client:
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False)
filters = 'operational eq \"operation\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional)
filters = 'operational eq \"operation\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* (optional)
try:
# Get Managed Clusters

View File

@@ -26,7 +26,7 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.account_usage import AccountUsage
account_usage = AccountUsage(
var_date='Thu Apr 20 20:00:00 EDT 2023',
var_date='Fri Apr 21 00:00:00 UTC 2023',
count=10
)

View File

@@ -19,8 +19,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | ManagedClient ID | [optional] [readonly]
**alert_key** | **str** | ManagedClient alert key | [optional] [readonly]
**api_gateway_base_url** | **str** | | [optional]
**cookbook** | **str** | | [optional]
**api_gateway_base_url** | **str** | apiGatewayBaseUrl for the Managed client | [optional]
**cookbook** | **str** | cookbook id for the Managed client | [optional]
**cc_id** | **int** | Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) | [optional]
**client_id** | **str** | The client ID used in API management | [required]
**cluster_id** | **str** | Cluster ID that the ManagedClient is linked to | [required]
@@ -38,6 +38,7 @@ Name | Type | Description | Notes
**created_at** | **datetime** | The date/time this ManagedClient was created | [optional]
**updated_at** | **datetime** | The date/time this ManagedClient was last updated | [optional]
**provision_status** | **Enum** [ 'PROVISIONED', 'DRAFT' ] | The provisioning status of the ManagedClient | [optional] [readonly]
**health_indicators** | **object** | The health indicators of the ManagedClient | [optional]
}
## Example
@@ -66,7 +67,8 @@ va_version='va-megapod-useast1-610-1621372012',
secret='ef878e15eaa8c8d3e2fa52f41125e2a0eeadadc6a14f931a33ad3e1b62d56381',
created_at='2023-08-04T20:48:01.865Z',
updated_at='2023-08-04T20:48:01.865Z',
provision_status='PROVISIONED'
provision_status='PROVISIONED',
health_indicators={ "network": { "errors": [], "warnings": [] }, "memory": { "errors": [], "warnings": [] }, "cpu": { "errors": [], "warnings": [] } }
)
```

View File

@@ -42,6 +42,12 @@ Name | Type | Description | Notes
**cc_id** | **str** | CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished | [optional] [default to '0']
**created_at** | **datetime** | The date/time this cluster was created | [optional]
**updated_at** | **datetime** | The date/time this cluster was last updated | [optional]
**last_release_notified_at** | **datetime** | The date/time this cluster was notified for the last release | [optional]
**update_preferences** | [**ManagedClusterUpdatePreferences**](managed-cluster-update-preferences) | | [optional]
**current_installed_release_version** | **str** | The current installed release on the Managed cluster | [optional]
**update_package** | **str** | New available updates for the Managed cluster | [optional]
**is_out_of_date_notified_at** | **datetime** | The time at which out of date notification was sent for the Managed cluster | [optional]
**consolidated_health_indicators_status** | **Enum** [ 'NORMAL', 'WARNING', 'ERROR' ] | The consolidated Health Status for the Managed cluster | [optional]
}
## Example
@@ -88,7 +94,16 @@ client_ids=[1244, 1245],
service_count=6,
cc_id='0',
created_at='2023-08-04T20:48:01.865Z',
updated_at='2023-08-04T20:48:01.865Z'
updated_at='2023-08-04T20:48:01.865Z',
last_release_notified_at='2025-03-11T07:00:13.729721Z',
update_preferences=sailpoint.v2024.models.managed_cluster_update_preferences.ManagedCluster_updatePreferences(
process_groups = '',
update_state = 'DISABLED',
notification_email = 'test@mail.com', ),
current_installed_release_version='123.1',
update_package='',
is_out_of_date_notified_at='2025-03-11T07:00:13.734393Z',
consolidated_health_indicators_status='ERROR'
)
```

View File

@@ -0,0 +1,38 @@
---
id: v2024-managed-cluster-update-preferences
title: ManagedClusterUpdatePreferences
pagination_label: ManagedClusterUpdatePreferences
sidebar_label: ManagedClusterUpdatePreferences
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ManagedClusterUpdatePreferences', 'V2024ManagedClusterUpdatePreferences']
slug: /tools/sdk/python/v2024/models/managed-cluster-update-preferences
tags: ['SDK', 'Software Development Kit', 'ManagedClusterUpdatePreferences', 'V2024ManagedClusterUpdatePreferences']
---
# ManagedClusterUpdatePreferences
The preference for applying updates for the cluster
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**process_groups** | **str** | The processGroups for updatePreferences | [optional]
**update_state** | **Enum** [ 'AUTO', 'DISABLED' ] | The current updateState for the cluster | [optional]
**notification_email** | **str** | The mail id to which new releases will be notified | [optional]
}
## Example
```python
from sailpoint.v2024.models.managed_cluster_update_preferences import ManagedClusterUpdatePreferences
managed_cluster_update_preferences = ManagedClusterUpdatePreferences(
process_groups='',
update_state='DISABLED',
notification_email='test@mail.com'
)
```
[[Back to top]](#)

View File

@@ -56,8 +56,8 @@ data={description=Auditing},
approval_status='APPROVED',
comment='approved',
completion_date='2020-03-24T11:11:41.139-05:00',
start_date='Mon Mar 23 20:00:00 EDT 2020',
end_date='Wed Mar 24 20:00:00 EDT 2021',
start_date='Tue Mar 24 00:00:00 UTC 2020',
end_date='Thu Mar 25 00:00:00 UTC 2021',
modified='2020-03-24T11:11:41.139-05:00',
created='2020-03-24T11:11:41.139-05:00'
)

View File

@@ -26,7 +26,7 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.source_usage import SourceUsage
source_usage = SourceUsage(
var_date='Thu Apr 20 20:00:00 EDT 2023',
var_date='Fri Apr 21 00:00:00 UTC 2023',
count=10.45
)

View File

@@ -26,7 +26,7 @@ Name | Type | Description | Notes
from sailpoint.v2025.models.account_usage import AccountUsage
account_usage = AccountUsage(
var_date='Thu Apr 20 20:00:00 EDT 2023',
var_date='Fri Apr 21 00:00:00 UTC 2023',
count=10
)

View File

@@ -56,8 +56,8 @@ data={description=Auditing},
approval_status='APPROVED',
comment='approved',
completion_date='2020-03-24T11:11:41.139-05:00',
start_date='Mon Mar 23 20:00:00 EDT 2020',
end_date='Wed Mar 24 20:00:00 EDT 2021',
start_date='Tue Mar 24 00:00:00 UTC 2020',
end_date='Thu Mar 25 00:00:00 UTC 2021',
modified='2020-03-24T11:11:41.139-05:00',
created='2020-03-24T11:11:41.139-05:00'
)

View File

@@ -26,7 +26,7 @@ Name | Type | Description | Notes
from sailpoint.v2025.models.source_usage import SourceUsage
source_usage = SourceUsage(
var_date='Thu Apr 20 20:00:00 EDT 2023',
var_date='Fri Apr 21 00:00:00 UTC 2023',
count=10.45
)

View File

@@ -26,7 +26,7 @@ Name | Type | Description | Notes
from sailpoint.v3.models.account_usage import AccountUsage
account_usage = AccountUsage(
var_date='Thu Apr 20 20:00:00 EDT 2023',
var_date='Fri Apr 21 00:00:00 UTC 2023',
count=10
)

View File

@@ -56,8 +56,8 @@ data={description=Auditing},
approval_status='APPROVED',
comment='approved',
completion_date='2020-03-24T11:11:41.139-05:00',
start_date='Mon Mar 23 20:00:00 EDT 2020',
end_date='Wed Mar 24 20:00:00 EDT 2021',
start_date='Tue Mar 24 00:00:00 UTC 2020',
end_date='Thu Mar 25 00:00:00 UTC 2021',
modified='2020-03-24T11:11:41.139-05:00',
created='2020-03-24T11:11:41.139-05:00'
)

View File

@@ -26,7 +26,7 @@ Name | Type | Description | Notes
from sailpoint.v3.models.source_usage import SourceUsage
source_usage = SourceUsage(
var_date='Thu Apr 20 20:00:00 EDT 2023',
var_date='Fri Apr 21 00:00:00 UTC 2023',
count=10.45
)

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff