ibm-platform-services 0.65.0__py3-none-any.whl → 0.66.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- ibm_platform_services/global_catalog_v1.py +506 -179
- ibm_platform_services/version.py +1 -1
- {ibm_platform_services-0.65.0.dist-info → ibm_platform_services-0.66.1.dist-info}/METADATA +3 -3
- {ibm_platform_services-0.65.0.dist-info → ibm_platform_services-0.66.1.dist-info}/RECORD +7 -7
- {ibm_platform_services-0.65.0.dist-info → ibm_platform_services-0.66.1.dist-info}/WHEEL +1 -1
- {ibm_platform_services-0.65.0.dist-info → ibm_platform_services-0.66.1.dist-info}/licenses/LICENSE +0 -0
- {ibm_platform_services-0.65.0.dist-info → ibm_platform_services-0.66.1.dist-info}/top_level.txt +0 -0
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
# See the License for the specific language governing permissions and
|
|
15
15
|
# limitations under the License.
|
|
16
16
|
|
|
17
|
-
# IBM OpenAPI SDK Code Generator Version: 3.
|
|
17
|
+
# IBM OpenAPI SDK Code Generator Version: 3.104.0-b4a47c49-20250418-184351
|
|
18
18
|
|
|
19
19
|
"""
|
|
20
20
|
The catalog service manages offerings across geographies as the system of record. The
|
|
@@ -215,8 +215,10 @@ class GlobalCatalogV1(BaseService):
|
|
|
215
215
|
:param str name: Programmatic name for this catalog entry, which must be
|
|
216
216
|
formatted like a CRN segment. See the display name in OverviewUI for a
|
|
217
217
|
user-readable name.
|
|
218
|
-
:param str kind: The type of catalog entry
|
|
219
|
-
|
|
218
|
+
:param str kind: The type of catalog entry which determines the type and
|
|
219
|
+
shape of the object. Valid GC types are buildpack, cname, dataset,
|
|
220
|
+
geography, iaas, platform_service, runtime, service, template,
|
|
221
|
+
ui-dashboard.
|
|
220
222
|
:param dict overview_ui: Overview is nested in the top level. The key value
|
|
221
223
|
pair is `[_language_]overview_ui`.
|
|
222
224
|
:param Image images: Image annotation for this catalog entry. The image is
|
|
@@ -224,8 +226,9 @@ class GlobalCatalogV1(BaseService):
|
|
|
224
226
|
:param bool disabled: Boolean value that determines the global visibility
|
|
225
227
|
for the catalog entry, and its children. If it is not enabled, all plans
|
|
226
228
|
are disabled.
|
|
227
|
-
:param List[str] tags: A list of tags. For example, IBM, 3rd
|
|
228
|
-
GA, and Single Tenant.
|
|
229
|
+
:param List[str] tags: A searchable list of tags. For example, IBM, 3rd
|
|
230
|
+
Party, Beta, GA, and Single Tenant. Valid values found at
|
|
231
|
+
https://globalcatalog.test.cloud.ibm.com/search.
|
|
229
232
|
:param Provider provider: Information related to the provider associated
|
|
230
233
|
with a catalog entry.
|
|
231
234
|
:param str id: Catalog entry's unique ID. It's the same across all catalog
|
|
@@ -432,8 +435,10 @@ class GlobalCatalogV1(BaseService):
|
|
|
432
435
|
:param str name: Programmatic name for this catalog entry, which must be
|
|
433
436
|
formatted like a CRN segment. See the display name in OverviewUI for a
|
|
434
437
|
user-readable name.
|
|
435
|
-
:param str kind: The type of catalog entry
|
|
436
|
-
|
|
438
|
+
:param str kind: The type of catalog entry which determines the type and
|
|
439
|
+
shape of the object. Valid GC types are buildpack, cname, dataset,
|
|
440
|
+
geography, iaas, platform_service, runtime, service, template,
|
|
441
|
+
ui-dashboard.
|
|
437
442
|
:param dict overview_ui: Overview is nested in the top level. The key value
|
|
438
443
|
pair is `[_language_]overview_ui`.
|
|
439
444
|
:param Image images: Image annotation for this catalog entry. The image is
|
|
@@ -441,8 +446,9 @@ class GlobalCatalogV1(BaseService):
|
|
|
441
446
|
:param bool disabled: Boolean value that determines the global visibility
|
|
442
447
|
for the catalog entry, and its children. If it is not enabled, all plans
|
|
443
448
|
are disabled.
|
|
444
|
-
:param List[str] tags: A list of tags. For example, IBM, 3rd
|
|
445
|
-
GA, and Single Tenant.
|
|
449
|
+
:param List[str] tags: A searchable list of tags. For example, IBM, 3rd
|
|
450
|
+
Party, Beta, GA, and Single Tenant. Valid values found at
|
|
451
|
+
https://globalcatalog.test.cloud.ibm.com/search.
|
|
446
452
|
:param Provider provider: Information related to the provider associated
|
|
447
453
|
with a catalog entry.
|
|
448
454
|
:param str parent_id: (optional) The ID of the parent catalog entry if it
|
|
@@ -824,6 +830,7 @@ class GlobalCatalogV1(BaseService):
|
|
|
824
830
|
self,
|
|
825
831
|
id: str,
|
|
826
832
|
*,
|
|
833
|
+
restrictions: Optional[str] = None,
|
|
827
834
|
extendable: Optional[bool] = None,
|
|
828
835
|
include: Optional['VisibilityDetail'] = None,
|
|
829
836
|
exclude: Optional['VisibilityDetail'] = None,
|
|
@@ -837,7 +844,13 @@ class GlobalCatalogV1(BaseService):
|
|
|
837
844
|
the provided token. This endpoint is ETag enabled.
|
|
838
845
|
|
|
839
846
|
:param str id: The object's unique ID.
|
|
840
|
-
:param
|
|
847
|
+
:param str restrictions: (optional) This controls the overall visibility.
|
|
848
|
+
It is an enum of *public*, *nonibm_only*, *ibm_only*, and *private*. public
|
|
849
|
+
means it is visible to all. nonibm_only means it is visible to all except
|
|
850
|
+
IBM unless their account is explicitly included, ibm_only means it is
|
|
851
|
+
visible to all IBM unless their account is explicitly excluded. private
|
|
852
|
+
means it is visible only to the included accounts.
|
|
853
|
+
:param bool extendable: (optional) Allows the visibility to be extendable.
|
|
841
854
|
:param VisibilityDetail include: (optional) Visibility details related to a
|
|
842
855
|
catalog entry.
|
|
843
856
|
:param VisibilityDetail exclude: (optional) Visibility details related to a
|
|
@@ -870,6 +883,7 @@ class GlobalCatalogV1(BaseService):
|
|
|
870
883
|
}
|
|
871
884
|
|
|
872
885
|
data = {
|
|
886
|
+
'restrictions': restrictions,
|
|
873
887
|
'extendable': extendable,
|
|
874
888
|
'include': include,
|
|
875
889
|
'exclude': exclude,
|
|
@@ -1962,33 +1976,56 @@ class CFMetaData:
|
|
|
1962
1976
|
"""
|
|
1963
1977
|
Service-related metadata.
|
|
1964
1978
|
|
|
1965
|
-
:param str type: (optional)
|
|
1979
|
+
:param str type: (optional) Deprecated: The type of service (public, cfaas,
|
|
1980
|
+
personal_catalog, kms, toolchain, etc.).
|
|
1966
1981
|
:param bool iam_compatible: (optional) Boolean value that describes whether the
|
|
1967
|
-
service is compatible with Identity and Access Management
|
|
1968
|
-
|
|
1969
|
-
|
|
1970
|
-
|
|
1971
|
-
|
|
1982
|
+
service is compatible with Identity and Access Management for authentication and
|
|
1983
|
+
authorization.
|
|
1984
|
+
:param bool unique_api_key: (optional) Deprecated: Boolean value that describes
|
|
1985
|
+
whether the service has a unique API key. Only settable on services, should be
|
|
1986
|
+
set via partnercenter.
|
|
1987
|
+
:param bool provisionable: (optional) Boolean value that, if true, the service
|
|
1988
|
+
is provisionable via resource controller (RC) or, if false, via a service
|
|
1989
|
+
control point API. If false, you may need sales or support to create this
|
|
1972
1990
|
service.
|
|
1973
|
-
:param bool bindable: (optional) Boolean value that describes whether
|
|
1974
|
-
|
|
1975
|
-
|
|
1976
|
-
|
|
1977
|
-
|
|
1978
|
-
|
|
1979
|
-
:param
|
|
1991
|
+
:param bool bindable: (optional) Boolean value that describes whether the
|
|
1992
|
+
service can be bound to an application. If true then this will create and use
|
|
1993
|
+
resource keys.
|
|
1994
|
+
:param bool async_provisioning_supported: (optional) Deprecated: Boolean value
|
|
1995
|
+
that describes whether the service supports asynchronous provisioning. Now
|
|
1996
|
+
handled by a 202 response indicating support from the broker on provisioning.
|
|
1997
|
+
:param bool async_unprovisioning_supported: (optional) Deprecated: Boolean value
|
|
1998
|
+
that describes whether the service supports asynchronous unprovisioning. Now
|
|
1999
|
+
handled by a 202 response indicating support from the broker on unprovisioning.
|
|
2000
|
+
:param List[str] requires: (optional) Deprecated: Dependencies needed to use
|
|
2001
|
+
this service.
|
|
1980
2002
|
:param bool plan_updateable: (optional) Boolean value that describes whether the
|
|
1981
|
-
service supports
|
|
1982
|
-
|
|
1983
|
-
|
|
1984
|
-
|
|
1985
|
-
|
|
1986
|
-
|
|
2003
|
+
service supports changing plans within the service. Only settable on services,
|
|
2004
|
+
read only on plans and deployments.
|
|
2005
|
+
:param str state: (optional) Deprecated: String that describes whether the
|
|
2006
|
+
service is active or inactive.
|
|
2007
|
+
:param bool service_check_enabled: (optional) Deprecated: Boolean value that
|
|
2008
|
+
describes whether the Estado testing service will perform uptime tests for this
|
|
2009
|
+
service.
|
|
2010
|
+
:param int test_check_interval: (optional) Deprecated: A unit of time that
|
|
2011
|
+
determines the time in between uptime checks performed by Estado.
|
|
1987
2012
|
:param bool service_key_supported: (optional) Boolean value that describes
|
|
1988
|
-
whether the service supports service
|
|
1989
|
-
|
|
1990
|
-
|
|
2013
|
+
whether the service supports the creation of service credentials. Without
|
|
2014
|
+
service key support, a service cannot be bound to a cluster.
|
|
2015
|
+
:param dict cf_guid: (optional) Deprecated: If the field is imported from Cloud
|
|
2016
|
+
Foundry, the Cloud Foundry region's GUID. This is a required field. For example,
|
|
1991
2017
|
`us-south=123`.
|
|
2018
|
+
:param str crn_mask: (optional) Cloud resource name identifying the environment
|
|
2019
|
+
containing this service.
|
|
2020
|
+
:param dict user_defined_service: (optional) Deprecated: An extended set of
|
|
2021
|
+
metadata fields that pertain to user-defined services.
|
|
2022
|
+
:param dict extension: (optional) Deprecated: A property-bag like extension to
|
|
2023
|
+
service metadata.
|
|
2024
|
+
:param bool paid_only: (optional) Deprecated: Boolean flag indicating if this
|
|
2025
|
+
service only offers paid pricing plans rather than the default paygo.
|
|
2026
|
+
:param bool custom_create_page_hybrid_enabled: (optional) Boolean flag that
|
|
2027
|
+
determines if the hybrid page is accessible from the main catalog provisioning
|
|
2028
|
+
page.
|
|
1992
2029
|
"""
|
|
1993
2030
|
|
|
1994
2031
|
def __init__(
|
|
@@ -2008,37 +2045,67 @@ class CFMetaData:
|
|
|
2008
2045
|
test_check_interval: Optional[int] = None,
|
|
2009
2046
|
service_key_supported: Optional[bool] = None,
|
|
2010
2047
|
cf_guid: Optional[dict] = None,
|
|
2048
|
+
crn_mask: Optional[str] = None,
|
|
2049
|
+
user_defined_service: Optional[dict] = None,
|
|
2050
|
+
extension: Optional[dict] = None,
|
|
2051
|
+
paid_only: Optional[bool] = None,
|
|
2052
|
+
custom_create_page_hybrid_enabled: Optional[bool] = None,
|
|
2011
2053
|
) -> None:
|
|
2012
2054
|
"""
|
|
2013
2055
|
Initialize a CFMetaData object.
|
|
2014
2056
|
|
|
2015
|
-
:param str type: (optional)
|
|
2057
|
+
:param str type: (optional) Deprecated: The type of service (public, cfaas,
|
|
2058
|
+
personal_catalog, kms, toolchain, etc.).
|
|
2016
2059
|
:param bool iam_compatible: (optional) Boolean value that describes whether
|
|
2017
|
-
the service is compatible with Identity and Access Management
|
|
2018
|
-
|
|
2019
|
-
|
|
2020
|
-
|
|
2021
|
-
|
|
2060
|
+
the service is compatible with Identity and Access Management for
|
|
2061
|
+
authentication and authorization.
|
|
2062
|
+
:param bool unique_api_key: (optional) Deprecated: Boolean value that
|
|
2063
|
+
describes whether the service has a unique API key. Only settable on
|
|
2064
|
+
services, should be set via partnercenter.
|
|
2065
|
+
:param bool provisionable: (optional) Boolean value that, if true, the
|
|
2066
|
+
service is provisionable via resource controller (RC) or, if false, via a
|
|
2067
|
+
service control point API. If false, you may need sales or support to
|
|
2022
2068
|
create this service.
|
|
2023
|
-
:param bool bindable: (optional) Boolean value that describes whether
|
|
2024
|
-
can
|
|
2025
|
-
|
|
2026
|
-
|
|
2027
|
-
|
|
2028
|
-
|
|
2029
|
-
|
|
2069
|
+
:param bool bindable: (optional) Boolean value that describes whether the
|
|
2070
|
+
service can be bound to an application. If true then this will create and
|
|
2071
|
+
use resource keys.
|
|
2072
|
+
:param bool async_provisioning_supported: (optional) Deprecated: Boolean
|
|
2073
|
+
value that describes whether the service supports asynchronous
|
|
2074
|
+
provisioning. Now handled by a 202 response indicating support from the
|
|
2075
|
+
broker on provisioning.
|
|
2076
|
+
:param bool async_unprovisioning_supported: (optional) Deprecated: Boolean
|
|
2077
|
+
value that describes whether the service supports asynchronous
|
|
2078
|
+
unprovisioning. Now handled by a 202 response indicating support from the
|
|
2079
|
+
broker on unprovisioning.
|
|
2080
|
+
:param List[str] requires: (optional) Deprecated: Dependencies needed to
|
|
2081
|
+
use this service.
|
|
2030
2082
|
:param bool plan_updateable: (optional) Boolean value that describes
|
|
2031
|
-
whether the service supports
|
|
2032
|
-
|
|
2033
|
-
|
|
2034
|
-
|
|
2035
|
-
|
|
2036
|
-
|
|
2083
|
+
whether the service supports changing plans within the service. Only
|
|
2084
|
+
settable on services, read only on plans and deployments.
|
|
2085
|
+
:param str state: (optional) Deprecated: String that describes whether the
|
|
2086
|
+
service is active or inactive.
|
|
2087
|
+
:param bool service_check_enabled: (optional) Deprecated: Boolean value
|
|
2088
|
+
that describes whether the Estado testing service will perform uptime tests
|
|
2089
|
+
for this service.
|
|
2090
|
+
:param int test_check_interval: (optional) Deprecated: A unit of time that
|
|
2091
|
+
determines the time in between uptime checks performed by Estado.
|
|
2037
2092
|
:param bool service_key_supported: (optional) Boolean value that describes
|
|
2038
|
-
whether the service supports service
|
|
2039
|
-
|
|
2040
|
-
|
|
2041
|
-
|
|
2093
|
+
whether the service supports the creation of service credentials. Without
|
|
2094
|
+
service key support, a service cannot be bound to a cluster.
|
|
2095
|
+
:param dict cf_guid: (optional) Deprecated: If the field is imported from
|
|
2096
|
+
Cloud Foundry, the Cloud Foundry region's GUID. This is a required field.
|
|
2097
|
+
For example, `us-south=123`.
|
|
2098
|
+
:param str crn_mask: (optional) Cloud resource name identifying the
|
|
2099
|
+
environment containing this service.
|
|
2100
|
+
:param dict user_defined_service: (optional) Deprecated: An extended set of
|
|
2101
|
+
metadata fields that pertain to user-defined services.
|
|
2102
|
+
:param dict extension: (optional) Deprecated: A property-bag like extension
|
|
2103
|
+
to service metadata.
|
|
2104
|
+
:param bool paid_only: (optional) Deprecated: Boolean flag indicating if
|
|
2105
|
+
this service only offers paid pricing plans rather than the default paygo.
|
|
2106
|
+
:param bool custom_create_page_hybrid_enabled: (optional) Boolean flag that
|
|
2107
|
+
determines if the hybrid page is accessible from the main catalog
|
|
2108
|
+
provisioning page.
|
|
2042
2109
|
"""
|
|
2043
2110
|
self.type = type
|
|
2044
2111
|
self.iam_compatible = iam_compatible
|
|
@@ -2054,6 +2121,11 @@ class CFMetaData:
|
|
|
2054
2121
|
self.test_check_interval = test_check_interval
|
|
2055
2122
|
self.service_key_supported = service_key_supported
|
|
2056
2123
|
self.cf_guid = cf_guid
|
|
2124
|
+
self.crn_mask = crn_mask
|
|
2125
|
+
self.user_defined_service = user_defined_service
|
|
2126
|
+
self.extension = extension
|
|
2127
|
+
self.paid_only = paid_only
|
|
2128
|
+
self.custom_create_page_hybrid_enabled = custom_create_page_hybrid_enabled
|
|
2057
2129
|
|
|
2058
2130
|
@classmethod
|
|
2059
2131
|
def from_dict(cls, _dict: Dict) -> 'CFMetaData':
|
|
@@ -2087,6 +2159,16 @@ class CFMetaData:
|
|
|
2087
2159
|
args['service_key_supported'] = service_key_supported
|
|
2088
2160
|
if (cf_guid := _dict.get('cf_guid')) is not None:
|
|
2089
2161
|
args['cf_guid'] = cf_guid
|
|
2162
|
+
if (crn_mask := _dict.get('crn_mask')) is not None:
|
|
2163
|
+
args['crn_mask'] = crn_mask
|
|
2164
|
+
if (user_defined_service := _dict.get('user_defined_service')) is not None:
|
|
2165
|
+
args['user_defined_service'] = user_defined_service
|
|
2166
|
+
if (extension := _dict.get('extension')) is not None:
|
|
2167
|
+
args['extension'] = extension
|
|
2168
|
+
if (paid_only := _dict.get('paid_only')) is not None:
|
|
2169
|
+
args['paid_only'] = paid_only
|
|
2170
|
+
if (custom_create_page_hybrid_enabled := _dict.get('custom_create_page_hybrid_enabled')) is not None:
|
|
2171
|
+
args['custom_create_page_hybrid_enabled'] = custom_create_page_hybrid_enabled
|
|
2090
2172
|
return cls(**args)
|
|
2091
2173
|
|
|
2092
2174
|
@classmethod
|
|
@@ -2125,6 +2207,16 @@ class CFMetaData:
|
|
|
2125
2207
|
_dict['service_key_supported'] = self.service_key_supported
|
|
2126
2208
|
if hasattr(self, 'cf_guid') and self.cf_guid is not None:
|
|
2127
2209
|
_dict['cf_guid'] = self.cf_guid
|
|
2210
|
+
if hasattr(self, 'crn_mask') and self.crn_mask is not None:
|
|
2211
|
+
_dict['crn_mask'] = self.crn_mask
|
|
2212
|
+
if hasattr(self, 'user_defined_service') and self.user_defined_service is not None:
|
|
2213
|
+
_dict['user_defined_service'] = self.user_defined_service
|
|
2214
|
+
if hasattr(self, 'extension') and self.extension is not None:
|
|
2215
|
+
_dict['extension'] = self.extension
|
|
2216
|
+
if hasattr(self, 'paid_only') and self.paid_only is not None:
|
|
2217
|
+
_dict['paid_only'] = self.paid_only
|
|
2218
|
+
if hasattr(self, 'custom_create_page_hybrid_enabled') and self.custom_create_page_hybrid_enabled is not None:
|
|
2219
|
+
_dict['custom_create_page_hybrid_enabled'] = self.custom_create_page_hybrid_enabled
|
|
2128
2220
|
return _dict
|
|
2129
2221
|
|
|
2130
2222
|
def _to_dict(self):
|
|
@@ -2152,8 +2244,8 @@ class Callbacks:
|
|
|
2152
2244
|
|
|
2153
2245
|
:param str controller_url: (optional) The URL of the deployment controller.
|
|
2154
2246
|
:param str broker_url: (optional) The URL of the deployment broker.
|
|
2155
|
-
:param str broker_proxy_url: (optional) The URL of the deployment
|
|
2156
|
-
proxy.
|
|
2247
|
+
:param str broker_proxy_url: (optional) Deprecated: The URL of the deployment
|
|
2248
|
+
broker SC proxy.
|
|
2157
2249
|
:param str dashboard_url: (optional) The URL of dashboard callback.
|
|
2158
2250
|
:param str dashboard_data_url: (optional) The URL of dashboard data.
|
|
2159
2251
|
:param str dashboard_detail_tab_url: (optional) The URL of the dashboard detail
|
|
@@ -2184,8 +2276,8 @@ class Callbacks:
|
|
|
2184
2276
|
|
|
2185
2277
|
:param str controller_url: (optional) The URL of the deployment controller.
|
|
2186
2278
|
:param str broker_url: (optional) The URL of the deployment broker.
|
|
2187
|
-
:param str broker_proxy_url: (optional) The URL of the
|
|
2188
|
-
proxy.
|
|
2279
|
+
:param str broker_proxy_url: (optional) Deprecated: The URL of the
|
|
2280
|
+
deployment broker SC proxy.
|
|
2189
2281
|
:param str dashboard_url: (optional) The URL of dashboard callback.
|
|
2190
2282
|
:param str dashboard_data_url: (optional) The URL of dashboard data.
|
|
2191
2283
|
:param str dashboard_detail_tab_url: (optional) The URL of the dashboard
|
|
@@ -2289,8 +2381,9 @@ class CatalogEntry:
|
|
|
2289
2381
|
:param str name: Programmatic name for this catalog entry, which must be
|
|
2290
2382
|
formatted like a CRN segment. See the display name in OverviewUI for a
|
|
2291
2383
|
user-readable name.
|
|
2292
|
-
:param str kind: The type of catalog entry
|
|
2293
|
-
|
|
2384
|
+
:param str kind: The type of catalog entry which determines the type and shape
|
|
2385
|
+
of the object. Valid GC types are buildpack, cname, dataset, geography, iaas,
|
|
2386
|
+
platform_service, runtime, service, template, ui-dashboard.
|
|
2294
2387
|
:param dict overview_ui: Overview is nested in the top level. The key value pair
|
|
2295
2388
|
is `[_language_]overview_ui`.
|
|
2296
2389
|
:param Image images: Image annotation for this catalog entry. The image is a
|
|
@@ -2300,8 +2393,9 @@ class CatalogEntry:
|
|
|
2300
2393
|
:param bool disabled: Boolean value that determines the global visibility for
|
|
2301
2394
|
the catalog entry, and its children. If it is not enabled, all plans are
|
|
2302
2395
|
disabled.
|
|
2303
|
-
:param List[str] tags: A list of tags. For example, IBM, 3rd Party,
|
|
2304
|
-
and Single Tenant.
|
|
2396
|
+
:param List[str] tags: A searchable list of tags. For example, IBM, 3rd Party,
|
|
2397
|
+
Beta, GA, and Single Tenant. Valid values found at
|
|
2398
|
+
https://globalcatalog.test.cloud.ibm.com/search.
|
|
2305
2399
|
:param bool group: (optional) Boolean value that determines whether the catalog
|
|
2306
2400
|
entry is a group.
|
|
2307
2401
|
:param Provider provider: Information related to the provider associated with a
|
|
@@ -2319,7 +2413,8 @@ class CatalogEntry:
|
|
|
2319
2413
|
:param List[str] geo_tags: (optional) tags to indicate the locations this
|
|
2320
2414
|
service is deployable to.
|
|
2321
2415
|
:param List[str] pricing_tags: (optional) tags to indicate the type of pricing
|
|
2322
|
-
plans this service supports.
|
|
2416
|
+
plans this service supports. Plans tagged with paid_only will not be shown for
|
|
2417
|
+
trial accounts.
|
|
2323
2418
|
:param datetime created: (optional) Date created.
|
|
2324
2419
|
:param datetime updated: (optional) Date last updated.
|
|
2325
2420
|
"""
|
|
@@ -2353,8 +2448,10 @@ class CatalogEntry:
|
|
|
2353
2448
|
:param str name: Programmatic name for this catalog entry, which must be
|
|
2354
2449
|
formatted like a CRN segment. See the display name in OverviewUI for a
|
|
2355
2450
|
user-readable name.
|
|
2356
|
-
:param str kind: The type of catalog entry
|
|
2357
|
-
|
|
2451
|
+
:param str kind: The type of catalog entry which determines the type and
|
|
2452
|
+
shape of the object. Valid GC types are buildpack, cname, dataset,
|
|
2453
|
+
geography, iaas, platform_service, runtime, service, template,
|
|
2454
|
+
ui-dashboard.
|
|
2358
2455
|
:param dict overview_ui: Overview is nested in the top level. The key value
|
|
2359
2456
|
pair is `[_language_]overview_ui`.
|
|
2360
2457
|
:param Image images: Image annotation for this catalog entry. The image is
|
|
@@ -2362,8 +2459,9 @@ class CatalogEntry:
|
|
|
2362
2459
|
:param bool disabled: Boolean value that determines the global visibility
|
|
2363
2460
|
for the catalog entry, and its children. If it is not enabled, all plans
|
|
2364
2461
|
are disabled.
|
|
2365
|
-
:param List[str] tags: A list of tags. For example, IBM, 3rd
|
|
2366
|
-
GA, and Single Tenant.
|
|
2462
|
+
:param List[str] tags: A searchable list of tags. For example, IBM, 3rd
|
|
2463
|
+
Party, Beta, GA, and Single Tenant. Valid values found at
|
|
2464
|
+
https://globalcatalog.test.cloud.ibm.com/search.
|
|
2367
2465
|
:param Provider provider: Information related to the provider associated
|
|
2368
2466
|
with a catalog entry.
|
|
2369
2467
|
:param str parent_id: (optional) The ID of the parent catalog entry if it
|
|
@@ -2536,8 +2634,9 @@ class CatalogEntry:
|
|
|
2536
2634
|
|
|
2537
2635
|
class KindEnum(str, Enum):
|
|
2538
2636
|
"""
|
|
2539
|
-
The type of catalog entry
|
|
2540
|
-
|
|
2637
|
+
The type of catalog entry which determines the type and shape of the object. Valid
|
|
2638
|
+
GC types are buildpack, cname, dataset, geography, iaas, platform_service,
|
|
2639
|
+
runtime, service, template, ui-dashboard.
|
|
2541
2640
|
"""
|
|
2542
2641
|
|
|
2543
2642
|
SERVICE = 'service'
|
|
@@ -2550,7 +2649,8 @@ class CatalogEntryMetadata:
|
|
|
2550
2649
|
Model used to describe metadata object returned.
|
|
2551
2650
|
|
|
2552
2651
|
:param bool rc_compatible: (optional) Boolean value that describes whether the
|
|
2553
|
-
service is compatible with the Resource Controller.
|
|
2652
|
+
service is compatible with the Resource Controller. Only settable for
|
|
2653
|
+
deployments, propogated upward.
|
|
2554
2654
|
:param CFMetaData service: (optional) Service-related metadata.
|
|
2555
2655
|
:param PlanMetaData plan: (optional) Plan-related metadata.
|
|
2556
2656
|
:param AliasMetaData alias: (optional) Alias-related metadata.
|
|
@@ -2563,7 +2663,8 @@ class CatalogEntryMetadata:
|
|
|
2563
2663
|
:param Callbacks callbacks: (optional) Callback-related information associated
|
|
2564
2664
|
with a catalog entry.
|
|
2565
2665
|
:param str original_name: (optional) The original name of the object.
|
|
2566
|
-
:param str version: (optional) Optional version of the object.
|
|
2666
|
+
:param str version: (optional) Deprecated: Optional version of the object. Only
|
|
2667
|
+
valid for templates.
|
|
2567
2668
|
:param dict other: (optional) Additional information.
|
|
2568
2669
|
:param CatalogEntryMetadataPricing pricing: (optional) Pricing-related
|
|
2569
2670
|
information.
|
|
@@ -2593,7 +2694,8 @@ class CatalogEntryMetadata:
|
|
|
2593
2694
|
Initialize a CatalogEntryMetadata object.
|
|
2594
2695
|
|
|
2595
2696
|
:param bool rc_compatible: (optional) Boolean value that describes whether
|
|
2596
|
-
the service is compatible with the Resource Controller.
|
|
2697
|
+
the service is compatible with the Resource Controller. Only settable for
|
|
2698
|
+
deployments, propogated upward.
|
|
2597
2699
|
:param CFMetaData service: (optional) Service-related metadata.
|
|
2598
2700
|
:param PlanMetaData plan: (optional) Plan-related metadata.
|
|
2599
2701
|
:param AliasMetaData alias: (optional) Alias-related metadata.
|
|
@@ -2607,7 +2709,8 @@ class CatalogEntryMetadata:
|
|
|
2607
2709
|
:param Callbacks callbacks: (optional) Callback-related information
|
|
2608
2710
|
associated with a catalog entry.
|
|
2609
2711
|
:param str original_name: (optional) The original name of the object.
|
|
2610
|
-
:param str version: (optional) Optional version of the object.
|
|
2712
|
+
:param str version: (optional) Deprecated: Optional version of the object.
|
|
2713
|
+
Only valid for templates.
|
|
2611
2714
|
:param dict other: (optional) Additional information.
|
|
2612
2715
|
:param CatalogEntryMetadataPricing pricing: (optional) Pricing-related
|
|
2613
2716
|
information.
|
|
@@ -2755,15 +2858,21 @@ class CatalogEntryMetadataDeployment:
|
|
|
2755
2858
|
located.
|
|
2756
2859
|
:param str location_url: (optional) Pointer to the location resource in the
|
|
2757
2860
|
catalog.
|
|
2758
|
-
:param str original_location: (optional)
|
|
2861
|
+
:param str original_location: (optional) The original region in which this
|
|
2862
|
+
deployment existed.
|
|
2759
2863
|
:param str target_crn: (optional) A CRN that describes the deployment.
|
|
2760
2864
|
crn:v1:[cname]:[ctype]:[location]:[scope]::[resource-type]:[resource].
|
|
2761
|
-
:param str service_crn: (optional)
|
|
2762
|
-
:param str mccp_id: (optional) ID
|
|
2865
|
+
:param str service_crn: (optional) Cloud resource name for this deployment.
|
|
2866
|
+
:param str mccp_id: (optional) Deprecated: ID of the multi cloud connectivity
|
|
2867
|
+
platform.
|
|
2763
2868
|
:param Broker broker: (optional) The broker associated with a catalog entry.
|
|
2764
|
-
:param bool supports_rc_migration: (optional) This deployment not
|
|
2765
|
-
RC but is ready to migrate and support the RC broker for a
|
|
2766
|
-
|
|
2869
|
+
:param bool supports_rc_migration: (optional) Deprecated: This deployment not
|
|
2870
|
+
only supports RC but is ready to migrate and support the RC broker for a
|
|
2871
|
+
location.
|
|
2872
|
+
:param str target_network: (optional) When using the service_endpoint_supported
|
|
2873
|
+
tag for a deployment, this optional field can be set on a deployment to denote
|
|
2874
|
+
the supported service endpoint type (cse_private, public, or
|
|
2875
|
+
cse_private+public).
|
|
2767
2876
|
"""
|
|
2768
2877
|
|
|
2769
2878
|
def __init__(
|
|
@@ -2784,17 +2893,22 @@ class CatalogEntryMetadataDeployment:
|
|
|
2784
2893
|
|
|
2785
2894
|
:param str location: (optional) Describes the region where the service is
|
|
2786
2895
|
located.
|
|
2787
|
-
:param str original_location: (optional)
|
|
2896
|
+
:param str original_location: (optional) The original region in which this
|
|
2897
|
+
deployment existed.
|
|
2788
2898
|
:param str target_crn: (optional) A CRN that describes the deployment.
|
|
2789
2899
|
crn:v1:[cname]:[ctype]:[location]:[scope]::[resource-type]:[resource].
|
|
2790
|
-
:param str service_crn: (optional)
|
|
2791
|
-
:param str mccp_id: (optional) ID
|
|
2900
|
+
:param str service_crn: (optional) Cloud resource name for this deployment.
|
|
2901
|
+
:param str mccp_id: (optional) Deprecated: ID of the multi cloud
|
|
2902
|
+
connectivity platform.
|
|
2792
2903
|
:param Broker broker: (optional) The broker associated with a catalog
|
|
2793
2904
|
entry.
|
|
2794
|
-
:param bool supports_rc_migration: (optional) This deployment
|
|
2795
|
-
supports RC but is ready to migrate and support the RC broker for
|
|
2796
|
-
location.
|
|
2797
|
-
:param str target_network: (optional)
|
|
2905
|
+
:param bool supports_rc_migration: (optional) Deprecated: This deployment
|
|
2906
|
+
not only supports RC but is ready to migrate and support the RC broker for
|
|
2907
|
+
a location.
|
|
2908
|
+
:param str target_network: (optional) When using the
|
|
2909
|
+
service_endpoint_supported tag for a deployment, this optional field can be
|
|
2910
|
+
set on a deployment to denote the supported service endpoint type
|
|
2911
|
+
(cse_private, public, or cse_private+public).
|
|
2798
2912
|
"""
|
|
2799
2913
|
self.location = location
|
|
2800
2914
|
self.location_url = location_url
|
|
@@ -2885,7 +2999,7 @@ class CatalogEntryMetadataPricing:
|
|
|
2885
2999
|
Pricing-related information.
|
|
2886
3000
|
|
|
2887
3001
|
:param str type: (optional) Type of plan. Valid values are `free`, `trial`,
|
|
2888
|
-
`paygo`, `
|
|
3002
|
+
`paygo`, `paid`, `subscription`.
|
|
2889
3003
|
:param str origin: (optional) Defines where the pricing originates.
|
|
2890
3004
|
:param StartingPrice starting_price: (optional) Plan-specific starting price
|
|
2891
3005
|
information.
|
|
@@ -2893,6 +3007,9 @@ class CatalogEntryMetadataPricing:
|
|
|
2893
3007
|
from. Only set if object kind is deployment.
|
|
2894
3008
|
:param str deployment_location: (optional) The deployment location this pricing
|
|
2895
3009
|
is from. Only set if object kind is deployment.
|
|
3010
|
+
:param str deployment_region: (optional) If price is for a deployment object
|
|
3011
|
+
then the region in the pricing catalog of the deployment object will be here. To
|
|
3012
|
+
be valid, this value must be contained within deployment_regions.
|
|
2896
3013
|
:param bool deployment_location_no_price_available: (optional) Is the location
|
|
2897
3014
|
price not available. Only set in api /pricing/deployment and only set if true.
|
|
2898
3015
|
This means for the given deployment object there was no pricing set in pricing
|
|
@@ -2900,6 +3017,17 @@ class CatalogEntryMetadataPricing:
|
|
|
2900
3017
|
:param List[Metrics] metrics: (optional) Plan-specific cost metric structure.
|
|
2901
3018
|
:param List[str] deployment_regions: (optional) List of regions where region
|
|
2902
3019
|
pricing is available. Only set on global deployments if enabled by owner.
|
|
3020
|
+
:param datetime effective_from: (optional) The start date-time indicating when
|
|
3021
|
+
this pricing plan takes effect.
|
|
3022
|
+
:param datetime effective_until: (optional) The end date-time indicating when
|
|
3023
|
+
this pricing plan is no longer in effect.
|
|
3024
|
+
:param bool require_login: (optional) Boolean value indicating whether or not
|
|
3025
|
+
this pricing plan requires login to get pricing data.
|
|
3026
|
+
:param str pricing_catalog_url: (optional) URL to the entry for this plan on the
|
|
3027
|
+
pricing catalog.
|
|
3028
|
+
:param List[str] sales_avenue: (optional) Tags describing how this plan was
|
|
3029
|
+
purchased (catalog [default], seller, private offer). Currently only settable on
|
|
3030
|
+
MCSP subscription plans.
|
|
2903
3031
|
"""
|
|
2904
3032
|
|
|
2905
3033
|
def __init__(
|
|
@@ -2910,15 +3038,21 @@ class CatalogEntryMetadataPricing:
|
|
|
2910
3038
|
starting_price: Optional['StartingPrice'] = None,
|
|
2911
3039
|
deployment_id: Optional[str] = None,
|
|
2912
3040
|
deployment_location: Optional[str] = None,
|
|
3041
|
+
deployment_region: Optional[str] = None,
|
|
2913
3042
|
deployment_location_no_price_available: Optional[bool] = None,
|
|
2914
3043
|
metrics: Optional[List['Metrics']] = None,
|
|
2915
3044
|
deployment_regions: Optional[List[str]] = None,
|
|
3045
|
+
effective_from: Optional[datetime] = None,
|
|
3046
|
+
effective_until: Optional[datetime] = None,
|
|
3047
|
+
require_login: Optional[bool] = None,
|
|
3048
|
+
pricing_catalog_url: Optional[str] = None,
|
|
3049
|
+
sales_avenue: Optional[List[str]] = None,
|
|
2916
3050
|
) -> None:
|
|
2917
3051
|
"""
|
|
2918
3052
|
Initialize a CatalogEntryMetadataPricing object.
|
|
2919
3053
|
|
|
2920
3054
|
:param str type: (optional) Type of plan. Valid values are `free`, `trial`,
|
|
2921
|
-
`paygo`, `
|
|
3055
|
+
`paygo`, `paid`, `subscription`.
|
|
2922
3056
|
:param str origin: (optional) Defines where the pricing originates.
|
|
2923
3057
|
:param StartingPrice starting_price: (optional) Plan-specific starting
|
|
2924
3058
|
price information.
|
|
@@ -2926,6 +3060,10 @@ class CatalogEntryMetadataPricing:
|
|
|
2926
3060
|
is from. Only set if object kind is deployment.
|
|
2927
3061
|
:param str deployment_location: (optional) The deployment location this
|
|
2928
3062
|
pricing is from. Only set if object kind is deployment.
|
|
3063
|
+
:param str deployment_region: (optional) If price is for a deployment
|
|
3064
|
+
object then the region in the pricing catalog of the deployment object will
|
|
3065
|
+
be here. To be valid, this value must be contained within
|
|
3066
|
+
deployment_regions.
|
|
2929
3067
|
:param bool deployment_location_no_price_available: (optional) Is the
|
|
2930
3068
|
location price not available. Only set in api /pricing/deployment and only
|
|
2931
3069
|
set if true. This means for the given deployment object there was no
|
|
@@ -2935,15 +3073,32 @@ class CatalogEntryMetadataPricing:
|
|
|
2935
3073
|
:param List[str] deployment_regions: (optional) List of regions where
|
|
2936
3074
|
region pricing is available. Only set on global deployments if enabled by
|
|
2937
3075
|
owner.
|
|
3076
|
+
:param datetime effective_from: (optional) The start date-time indicating
|
|
3077
|
+
when this pricing plan takes effect.
|
|
3078
|
+
:param datetime effective_until: (optional) The end date-time indicating
|
|
3079
|
+
when this pricing plan is no longer in effect.
|
|
3080
|
+
:param bool require_login: (optional) Boolean value indicating whether or
|
|
3081
|
+
not this pricing plan requires login to get pricing data.
|
|
3082
|
+
:param str pricing_catalog_url: (optional) URL to the entry for this plan
|
|
3083
|
+
on the pricing catalog.
|
|
3084
|
+
:param List[str] sales_avenue: (optional) Tags describing how this plan was
|
|
3085
|
+
purchased (catalog [default], seller, private offer). Currently only
|
|
3086
|
+
settable on MCSP subscription plans.
|
|
2938
3087
|
"""
|
|
2939
3088
|
self.type = type
|
|
2940
3089
|
self.origin = origin
|
|
2941
3090
|
self.starting_price = starting_price
|
|
2942
3091
|
self.deployment_id = deployment_id
|
|
2943
3092
|
self.deployment_location = deployment_location
|
|
3093
|
+
self.deployment_region = deployment_region
|
|
2944
3094
|
self.deployment_location_no_price_available = deployment_location_no_price_available
|
|
2945
3095
|
self.metrics = metrics
|
|
2946
3096
|
self.deployment_regions = deployment_regions
|
|
3097
|
+
self.effective_from = effective_from
|
|
3098
|
+
self.effective_until = effective_until
|
|
3099
|
+
self.require_login = require_login
|
|
3100
|
+
self.pricing_catalog_url = pricing_catalog_url
|
|
3101
|
+
self.sales_avenue = sales_avenue
|
|
2947
3102
|
|
|
2948
3103
|
@classmethod
|
|
2949
3104
|
def from_dict(cls, _dict: Dict) -> 'CatalogEntryMetadataPricing':
|
|
@@ -2959,12 +3114,24 @@ class CatalogEntryMetadataPricing:
|
|
|
2959
3114
|
args['deployment_id'] = deployment_id
|
|
2960
3115
|
if (deployment_location := _dict.get('deployment_location')) is not None:
|
|
2961
3116
|
args['deployment_location'] = deployment_location
|
|
3117
|
+
if (deployment_region := _dict.get('deployment_region')) is not None:
|
|
3118
|
+
args['deployment_region'] = deployment_region
|
|
2962
3119
|
if (deployment_location_no_price_available := _dict.get('deployment_location_no_price_available')) is not None:
|
|
2963
3120
|
args['deployment_location_no_price_available'] = deployment_location_no_price_available
|
|
2964
3121
|
if (metrics := _dict.get('metrics')) is not None:
|
|
2965
3122
|
args['metrics'] = [Metrics.from_dict(v) for v in metrics]
|
|
2966
3123
|
if (deployment_regions := _dict.get('deployment_regions')) is not None:
|
|
2967
3124
|
args['deployment_regions'] = deployment_regions
|
|
3125
|
+
if (effective_from := _dict.get('effective_from')) is not None:
|
|
3126
|
+
args['effective_from'] = string_to_datetime(effective_from)
|
|
3127
|
+
if (effective_until := _dict.get('effective_until')) is not None:
|
|
3128
|
+
args['effective_until'] = string_to_datetime(effective_until)
|
|
3129
|
+
if (require_login := _dict.get('require_login')) is not None:
|
|
3130
|
+
args['require_login'] = require_login
|
|
3131
|
+
if (pricing_catalog_url := _dict.get('pricing_catalog_url')) is not None:
|
|
3132
|
+
args['pricing_catalog_url'] = pricing_catalog_url
|
|
3133
|
+
if (sales_avenue := _dict.get('sales_avenue')) is not None:
|
|
3134
|
+
args['sales_avenue'] = sales_avenue
|
|
2968
3135
|
return cls(**args)
|
|
2969
3136
|
|
|
2970
3137
|
@classmethod
|
|
@@ -2988,6 +3155,8 @@ class CatalogEntryMetadataPricing:
|
|
|
2988
3155
|
_dict['deployment_id'] = self.deployment_id
|
|
2989
3156
|
if hasattr(self, 'deployment_location') and self.deployment_location is not None:
|
|
2990
3157
|
_dict['deployment_location'] = self.deployment_location
|
|
3158
|
+
if hasattr(self, 'deployment_region') and self.deployment_region is not None:
|
|
3159
|
+
_dict['deployment_region'] = self.deployment_region
|
|
2991
3160
|
if (
|
|
2992
3161
|
hasattr(self, 'deployment_location_no_price_available')
|
|
2993
3162
|
and self.deployment_location_no_price_available is not None
|
|
@@ -3003,6 +3172,16 @@ class CatalogEntryMetadataPricing:
|
|
|
3003
3172
|
_dict['metrics'] = metrics_list
|
|
3004
3173
|
if hasattr(self, 'deployment_regions') and self.deployment_regions is not None:
|
|
3005
3174
|
_dict['deployment_regions'] = self.deployment_regions
|
|
3175
|
+
if hasattr(self, 'effective_from') and self.effective_from is not None:
|
|
3176
|
+
_dict['effective_from'] = datetime_to_string(self.effective_from)
|
|
3177
|
+
if hasattr(self, 'effective_until') and self.effective_until is not None:
|
|
3178
|
+
_dict['effective_until'] = datetime_to_string(self.effective_until)
|
|
3179
|
+
if hasattr(self, 'require_login') and self.require_login is not None:
|
|
3180
|
+
_dict['require_login'] = self.require_login
|
|
3181
|
+
if hasattr(self, 'pricing_catalog_url') and self.pricing_catalog_url is not None:
|
|
3182
|
+
_dict['pricing_catalog_url'] = self.pricing_catalog_url
|
|
3183
|
+
if hasattr(self, 'sales_avenue') and self.sales_avenue is not None:
|
|
3184
|
+
_dict['sales_avenue'] = self.sales_avenue
|
|
3006
3185
|
return _dict
|
|
3007
3186
|
|
|
3008
3187
|
def _to_dict(self):
|
|
@@ -3101,15 +3280,21 @@ class DeploymentBase:
|
|
|
3101
3280
|
:param str location: (optional) Describes the region where the service is
|
|
3102
3281
|
located.
|
|
3103
3282
|
:param str location_url: (optional) URL of deployment.
|
|
3104
|
-
:param str original_location: (optional)
|
|
3283
|
+
:param str original_location: (optional) The original region in which this
|
|
3284
|
+
deployment existed.
|
|
3105
3285
|
:param str target_crn: (optional) A CRN that describes the deployment.
|
|
3106
3286
|
crn:v1:[cname]:[ctype]:[location]:[scope]::[resource-type]:[resource].
|
|
3107
|
-
:param str service_crn: (optional)
|
|
3108
|
-
:param str mccp_id: (optional) ID
|
|
3287
|
+
:param str service_crn: (optional) Cloud resource name for this deployment.
|
|
3288
|
+
:param str mccp_id: (optional) Deprecated: ID of the multi cloud connectivity
|
|
3289
|
+
platform.
|
|
3109
3290
|
:param Broker broker: (optional) The broker associated with a catalog entry.
|
|
3110
|
-
:param bool supports_rc_migration: (optional) This deployment not
|
|
3111
|
-
RC but is ready to migrate and support the RC broker for a
|
|
3112
|
-
|
|
3291
|
+
:param bool supports_rc_migration: (optional) Deprecated: This deployment not
|
|
3292
|
+
only supports RC but is ready to migrate and support the RC broker for a
|
|
3293
|
+
location.
|
|
3294
|
+
:param str target_network: (optional) When using the service_endpoint_supported
|
|
3295
|
+
tag for a deployment, this optional field can be set on a deployment to denote
|
|
3296
|
+
the supported service endpoint type (cse_private, public, or
|
|
3297
|
+
cse_private+public).
|
|
3113
3298
|
"""
|
|
3114
3299
|
|
|
3115
3300
|
def __init__(
|
|
@@ -3131,17 +3316,22 @@ class DeploymentBase:
|
|
|
3131
3316
|
:param str location: (optional) Describes the region where the service is
|
|
3132
3317
|
located.
|
|
3133
3318
|
:param str location_url: (optional) URL of deployment.
|
|
3134
|
-
:param str original_location: (optional)
|
|
3319
|
+
:param str original_location: (optional) The original region in which this
|
|
3320
|
+
deployment existed.
|
|
3135
3321
|
:param str target_crn: (optional) A CRN that describes the deployment.
|
|
3136
3322
|
crn:v1:[cname]:[ctype]:[location]:[scope]::[resource-type]:[resource].
|
|
3137
|
-
:param str service_crn: (optional)
|
|
3138
|
-
:param str mccp_id: (optional) ID
|
|
3323
|
+
:param str service_crn: (optional) Cloud resource name for this deployment.
|
|
3324
|
+
:param str mccp_id: (optional) Deprecated: ID of the multi cloud
|
|
3325
|
+
connectivity platform.
|
|
3139
3326
|
:param Broker broker: (optional) The broker associated with a catalog
|
|
3140
3327
|
entry.
|
|
3141
|
-
:param bool supports_rc_migration: (optional) This deployment
|
|
3142
|
-
supports RC but is ready to migrate and support the RC broker for
|
|
3143
|
-
location.
|
|
3144
|
-
:param str target_network: (optional)
|
|
3328
|
+
:param bool supports_rc_migration: (optional) Deprecated: This deployment
|
|
3329
|
+
not only supports RC but is ready to migrate and support the RC broker for
|
|
3330
|
+
a location.
|
|
3331
|
+
:param str target_network: (optional) When using the
|
|
3332
|
+
service_endpoint_supported tag for a deployment, this optional field can be
|
|
3333
|
+
set on a deployment to denote the supported service endpoint type
|
|
3334
|
+
(cse_private, public, or cse_private+public).
|
|
3145
3335
|
"""
|
|
3146
3336
|
self.location = location
|
|
3147
3337
|
self.location_url = location_url
|
|
@@ -3606,20 +3796,30 @@ class Metrics:
|
|
|
3606
3796
|
"""
|
|
3607
3797
|
Plan-specific cost metrics information.
|
|
3608
3798
|
|
|
3609
|
-
:param str part_ref: (optional) The part
|
|
3799
|
+
:param str part_ref: (optional) The reference guid for the part.
|
|
3610
3800
|
:param str metric_id: (optional) The metric ID or part number.
|
|
3611
|
-
:param str tier_model: (optional) The tier
|
|
3612
|
-
|
|
3613
|
-
:param str
|
|
3614
|
-
:param
|
|
3615
|
-
|
|
3616
|
-
:param
|
|
3617
|
-
|
|
3618
|
-
:param
|
|
3619
|
-
|
|
3620
|
-
:param
|
|
3801
|
+
:param str tier_model: (optional) The pricing tier type used to calculate the
|
|
3802
|
+
marginal unit price. Follows simple, graduated or block tier styles.
|
|
3803
|
+
:param str charge_unit: (optional) The unit to be charged under this metric.
|
|
3804
|
+
:param str charge_unit_name: (optional) The name associated with a charge unit
|
|
3805
|
+
to provide context.
|
|
3806
|
+
:param int charge_unit_quantity: (optional) The quantity associated with the
|
|
3807
|
+
charge unit to determine price change intervals.
|
|
3808
|
+
:param str resource_display_name: (optional) The display name of the resource
|
|
3809
|
+
tied to the charge unit of this metric.
|
|
3810
|
+
:param str charge_unit_display_name: (optional) Display name of the charge unit
|
|
3811
|
+
to be rendered human readable by the UI.
|
|
3812
|
+
:param int usage_cap_qty: (optional) Upper bound for the usage under the parent
|
|
3813
|
+
metric.
|
|
3814
|
+
:param int display_cap: (optional) The display capacity for the UI.
|
|
3815
|
+
:param datetime effective_from: (optional) The end date-time indicating when
|
|
3816
|
+
this metric is no longer in effect.
|
|
3817
|
+
:param datetime effective_until: (optional) The start date-time indicating when
|
|
3818
|
+
this metric takes effect.
|
|
3621
3819
|
:param List[Amount] amounts: (optional) The pricing per metric by country and
|
|
3622
3820
|
currency.
|
|
3821
|
+
:param dict additional_properties: (optional) A property-bag like extension to
|
|
3822
|
+
metric metadata.
|
|
3623
3823
|
"""
|
|
3624
3824
|
|
|
3625
3825
|
def __init__(
|
|
@@ -3638,25 +3838,36 @@ class Metrics:
|
|
|
3638
3838
|
effective_from: Optional[datetime] = None,
|
|
3639
3839
|
effective_until: Optional[datetime] = None,
|
|
3640
3840
|
amounts: Optional[List['Amount']] = None,
|
|
3841
|
+
additional_properties: Optional[dict] = None,
|
|
3641
3842
|
) -> None:
|
|
3642
3843
|
"""
|
|
3643
3844
|
Initialize a Metrics object.
|
|
3644
3845
|
|
|
3645
|
-
:param str part_ref: (optional) The part
|
|
3846
|
+
:param str part_ref: (optional) The reference guid for the part.
|
|
3646
3847
|
:param str metric_id: (optional) The metric ID or part number.
|
|
3647
|
-
:param str tier_model: (optional) The tier
|
|
3648
|
-
|
|
3649
|
-
:param str
|
|
3650
|
-
|
|
3651
|
-
:param str
|
|
3848
|
+
:param str tier_model: (optional) The pricing tier type used to calculate
|
|
3849
|
+
the marginal unit price. Follows simple, graduated or block tier styles.
|
|
3850
|
+
:param str charge_unit: (optional) The unit to be charged under this
|
|
3851
|
+
metric.
|
|
3852
|
+
:param str charge_unit_name: (optional) The name associated with a charge
|
|
3853
|
+
unit to provide context.
|
|
3854
|
+
:param int charge_unit_quantity: (optional) The quantity associated with
|
|
3855
|
+
the charge unit to determine price change intervals.
|
|
3856
|
+
:param str resource_display_name: (optional) The display name of the
|
|
3857
|
+
resource tied to the charge unit of this metric.
|
|
3652
3858
|
:param str charge_unit_display_name: (optional) Display name of the charge
|
|
3653
|
-
unit.
|
|
3654
|
-
:param int usage_cap_qty: (optional)
|
|
3655
|
-
|
|
3656
|
-
:param
|
|
3657
|
-
:param datetime
|
|
3859
|
+
unit to be rendered human readable by the UI.
|
|
3860
|
+
:param int usage_cap_qty: (optional) Upper bound for the usage under the
|
|
3861
|
+
parent metric.
|
|
3862
|
+
:param int display_cap: (optional) The display capacity for the UI.
|
|
3863
|
+
:param datetime effective_from: (optional) The end date-time indicating
|
|
3864
|
+
when this metric is no longer in effect.
|
|
3865
|
+
:param datetime effective_until: (optional) The start date-time indicating
|
|
3866
|
+
when this metric takes effect.
|
|
3658
3867
|
:param List[Amount] amounts: (optional) The pricing per metric by country
|
|
3659
3868
|
and currency.
|
|
3869
|
+
:param dict additional_properties: (optional) A property-bag like extension
|
|
3870
|
+
to metric metadata.
|
|
3660
3871
|
"""
|
|
3661
3872
|
self.part_ref = part_ref
|
|
3662
3873
|
self.metric_id = metric_id
|
|
@@ -3671,6 +3882,7 @@ class Metrics:
|
|
|
3671
3882
|
self.effective_from = effective_from
|
|
3672
3883
|
self.effective_until = effective_until
|
|
3673
3884
|
self.amounts = amounts
|
|
3885
|
+
self.additional_properties = additional_properties
|
|
3674
3886
|
|
|
3675
3887
|
@classmethod
|
|
3676
3888
|
def from_dict(cls, _dict: Dict) -> 'Metrics':
|
|
@@ -3702,6 +3914,8 @@ class Metrics:
|
|
|
3702
3914
|
args['effective_until'] = string_to_datetime(effective_until)
|
|
3703
3915
|
if (amounts := _dict.get('amounts')) is not None:
|
|
3704
3916
|
args['amounts'] = [Amount.from_dict(v) for v in amounts]
|
|
3917
|
+
if (additional_properties := _dict.get('additional_properties')) is not None:
|
|
3918
|
+
args['additional_properties'] = additional_properties
|
|
3705
3919
|
return cls(**args)
|
|
3706
3920
|
|
|
3707
3921
|
@classmethod
|
|
@@ -3744,6 +3958,8 @@ class Metrics:
|
|
|
3744
3958
|
else:
|
|
3745
3959
|
amounts_list.append(v.to_dict())
|
|
3746
3960
|
_dict['amounts'] = amounts_list
|
|
3961
|
+
if hasattr(self, 'additional_properties') and self.additional_properties is not None:
|
|
3962
|
+
_dict['additional_properties'] = self.additional_properties
|
|
3747
3963
|
return _dict
|
|
3748
3964
|
|
|
3749
3965
|
def _to_dict(self):
|
|
@@ -3770,7 +3986,8 @@ class ObjectMetadataSet:
|
|
|
3770
3986
|
Model used to describe metadata object that can be set.
|
|
3771
3987
|
|
|
3772
3988
|
:param bool rc_compatible: (optional) Boolean value that describes whether the
|
|
3773
|
-
service is compatible with the Resource Controller.
|
|
3989
|
+
service is compatible with the Resource Controller. Only settable for
|
|
3990
|
+
deployments, propogated upward.
|
|
3774
3991
|
:param CFMetaData service: (optional) Service-related metadata.
|
|
3775
3992
|
:param PlanMetaData plan: (optional) Plan-related metadata.
|
|
3776
3993
|
:param AliasMetaData alias: (optional) Alias-related metadata.
|
|
@@ -3783,7 +4000,8 @@ class ObjectMetadataSet:
|
|
|
3783
4000
|
:param Callbacks callbacks: (optional) Callback-related information associated
|
|
3784
4001
|
with a catalog entry.
|
|
3785
4002
|
:param str original_name: (optional) The original name of the object.
|
|
3786
|
-
:param str version: (optional) Optional version of the object.
|
|
4003
|
+
:param str version: (optional) Deprecated: Optional version of the object. Only
|
|
4004
|
+
valid for templates.
|
|
3787
4005
|
:param dict other: (optional) Additional information.
|
|
3788
4006
|
:param PricingSet pricing: (optional) Pricing-related information.
|
|
3789
4007
|
:param DeploymentBase deployment: (optional) Deployment-related metadata.
|
|
@@ -3811,7 +4029,8 @@ class ObjectMetadataSet:
|
|
|
3811
4029
|
Initialize a ObjectMetadataSet object.
|
|
3812
4030
|
|
|
3813
4031
|
:param bool rc_compatible: (optional) Boolean value that describes whether
|
|
3814
|
-
the service is compatible with the Resource Controller.
|
|
4032
|
+
the service is compatible with the Resource Controller. Only settable for
|
|
4033
|
+
deployments, propogated upward.
|
|
3815
4034
|
:param CFMetaData service: (optional) Service-related metadata.
|
|
3816
4035
|
:param PlanMetaData plan: (optional) Plan-related metadata.
|
|
3817
4036
|
:param AliasMetaData alias: (optional) Alias-related metadata.
|
|
@@ -3825,7 +4044,8 @@ class ObjectMetadataSet:
|
|
|
3825
4044
|
:param Callbacks callbacks: (optional) Callback-related information
|
|
3826
4045
|
associated with a catalog entry.
|
|
3827
4046
|
:param str original_name: (optional) The original name of the object.
|
|
3828
|
-
:param str version: (optional) Optional version of the object.
|
|
4047
|
+
:param str version: (optional) Deprecated: Optional version of the object.
|
|
4048
|
+
Only valid for templates.
|
|
3829
4049
|
:param dict other: (optional) Additional information.
|
|
3830
4050
|
:param PricingSet pricing: (optional) Pricing-related information.
|
|
3831
4051
|
:param DeploymentBase deployment: (optional) Deployment-related metadata.
|
|
@@ -4058,21 +4278,31 @@ class PlanMetaData:
|
|
|
4058
4278
|
Plan-related metadata.
|
|
4059
4279
|
|
|
4060
4280
|
:param bool bindable: (optional) Boolean value that describes whether the
|
|
4061
|
-
service can be bound to an application.
|
|
4281
|
+
service can be bound to an application. If true then this will create and use
|
|
4282
|
+
resource keys.
|
|
4062
4283
|
:param bool reservable: (optional) Boolean value that describes whether the
|
|
4063
|
-
service can be reserved.
|
|
4284
|
+
service can be reserved for pricing subscriptions.
|
|
4064
4285
|
:param bool allow_internal_users: (optional) Boolean value that describes
|
|
4065
|
-
whether the service can be used
|
|
4066
|
-
|
|
4067
|
-
|
|
4068
|
-
|
|
4069
|
-
|
|
4070
|
-
:param
|
|
4071
|
-
|
|
4072
|
-
|
|
4073
|
-
|
|
4074
|
-
|
|
4075
|
-
|
|
4286
|
+
whether the service can be used on IBM accounts. If false this cannot be
|
|
4287
|
+
onboarded by an IBM account.
|
|
4288
|
+
:param bool async_provisioning_supported: (optional) Deprecated: Boolean value
|
|
4289
|
+
that describes whether the service supports asynchronous provisioning. Now
|
|
4290
|
+
handled by a 202 response indicating support from the broker on provisioning.
|
|
4291
|
+
:param bool async_unprovisioning_supported: (optional) Deprecated: Boolean value
|
|
4292
|
+
that describes whether the service supports asynchronous unprovisioning. Now
|
|
4293
|
+
handled by a 202 response indicating support from the broker on unprovisioning.
|
|
4294
|
+
:param str provision_type: (optional) How the subscription is provisioned
|
|
4295
|
+
(managed cloud service provider (mcsp), IBM_cloud, legacy).
|
|
4296
|
+
:param int test_check_interval: (optional) Deprecated: A unit of time that
|
|
4297
|
+
determines the time in between uptime checks to be performed by the Estado
|
|
4298
|
+
testing service.
|
|
4299
|
+
:param str single_scope_instance: (optional) Deprecated: String denoting if a
|
|
4300
|
+
single instance is shared among a group of users. E.g. org.
|
|
4301
|
+
:param bool service_check_enabled: (optional) Deprecated: Boolean value that
|
|
4302
|
+
describes whether the Estado testing service will perform uptime tests for this
|
|
4303
|
+
service.
|
|
4304
|
+
:param dict cf_guid: (optional) Deprecated: If the field is imported from Cloud
|
|
4305
|
+
Foundry, the Cloud Foundry region's GUID. This is a required field. For example,
|
|
4076
4306
|
`us-south=123`.
|
|
4077
4307
|
"""
|
|
4078
4308
|
|
|
@@ -4084,6 +4314,7 @@ class PlanMetaData:
|
|
|
4084
4314
|
allow_internal_users: Optional[bool] = None,
|
|
4085
4315
|
async_provisioning_supported: Optional[bool] = None,
|
|
4086
4316
|
async_unprovisioning_supported: Optional[bool] = None,
|
|
4317
|
+
provision_type: Optional[str] = None,
|
|
4087
4318
|
test_check_interval: Optional[int] = None,
|
|
4088
4319
|
single_scope_instance: Optional[str] = None,
|
|
4089
4320
|
service_check_enabled: Optional[bool] = None,
|
|
@@ -4093,28 +4324,41 @@ class PlanMetaData:
|
|
|
4093
4324
|
Initialize a PlanMetaData object.
|
|
4094
4325
|
|
|
4095
4326
|
:param bool bindable: (optional) Boolean value that describes whether the
|
|
4096
|
-
service can be bound to an application.
|
|
4327
|
+
service can be bound to an application. If true then this will create and
|
|
4328
|
+
use resource keys.
|
|
4097
4329
|
:param bool reservable: (optional) Boolean value that describes whether the
|
|
4098
|
-
service can be reserved.
|
|
4330
|
+
service can be reserved for pricing subscriptions.
|
|
4099
4331
|
:param bool allow_internal_users: (optional) Boolean value that describes
|
|
4100
|
-
whether the service can be used
|
|
4101
|
-
|
|
4102
|
-
|
|
4103
|
-
|
|
4104
|
-
|
|
4105
|
-
|
|
4106
|
-
:param
|
|
4107
|
-
|
|
4108
|
-
|
|
4109
|
-
|
|
4110
|
-
|
|
4111
|
-
|
|
4332
|
+
whether the service can be used on IBM accounts. If false this cannot be
|
|
4333
|
+
onboarded by an IBM account.
|
|
4334
|
+
:param bool async_provisioning_supported: (optional) Deprecated: Boolean
|
|
4335
|
+
value that describes whether the service supports asynchronous
|
|
4336
|
+
provisioning. Now handled by a 202 response indicating support from the
|
|
4337
|
+
broker on provisioning.
|
|
4338
|
+
:param bool async_unprovisioning_supported: (optional) Deprecated: Boolean
|
|
4339
|
+
value that describes whether the service supports asynchronous
|
|
4340
|
+
unprovisioning. Now handled by a 202 response indicating support from the
|
|
4341
|
+
broker on unprovisioning.
|
|
4342
|
+
:param str provision_type: (optional) How the subscription is provisioned
|
|
4343
|
+
(managed cloud service provider (mcsp), IBM_cloud, legacy).
|
|
4344
|
+
:param int test_check_interval: (optional) Deprecated: A unit of time that
|
|
4345
|
+
determines the time in between uptime checks to be performed by the Estado
|
|
4346
|
+
testing service.
|
|
4347
|
+
:param str single_scope_instance: (optional) Deprecated: String denoting if
|
|
4348
|
+
a single instance is shared among a group of users. E.g. org.
|
|
4349
|
+
:param bool service_check_enabled: (optional) Deprecated: Boolean value
|
|
4350
|
+
that describes whether the Estado testing service will perform uptime tests
|
|
4351
|
+
for this service.
|
|
4352
|
+
:param dict cf_guid: (optional) Deprecated: If the field is imported from
|
|
4353
|
+
Cloud Foundry, the Cloud Foundry region's GUID. This is a required field.
|
|
4354
|
+
For example, `us-south=123`.
|
|
4112
4355
|
"""
|
|
4113
4356
|
self.bindable = bindable
|
|
4114
4357
|
self.reservable = reservable
|
|
4115
4358
|
self.allow_internal_users = allow_internal_users
|
|
4116
4359
|
self.async_provisioning_supported = async_provisioning_supported
|
|
4117
4360
|
self.async_unprovisioning_supported = async_unprovisioning_supported
|
|
4361
|
+
self.provision_type = provision_type
|
|
4118
4362
|
self.test_check_interval = test_check_interval
|
|
4119
4363
|
self.single_scope_instance = single_scope_instance
|
|
4120
4364
|
self.service_check_enabled = service_check_enabled
|
|
@@ -4134,6 +4378,8 @@ class PlanMetaData:
|
|
|
4134
4378
|
args['async_provisioning_supported'] = async_provisioning_supported
|
|
4135
4379
|
if (async_unprovisioning_supported := _dict.get('async_unprovisioning_supported')) is not None:
|
|
4136
4380
|
args['async_unprovisioning_supported'] = async_unprovisioning_supported
|
|
4381
|
+
if (provision_type := _dict.get('provision_type')) is not None:
|
|
4382
|
+
args['provision_type'] = provision_type
|
|
4137
4383
|
if (test_check_interval := _dict.get('test_check_interval')) is not None:
|
|
4138
4384
|
args['test_check_interval'] = test_check_interval
|
|
4139
4385
|
if (single_scope_instance := _dict.get('single_scope_instance')) is not None:
|
|
@@ -4162,6 +4408,8 @@ class PlanMetaData:
|
|
|
4162
4408
|
_dict['async_provisioning_supported'] = self.async_provisioning_supported
|
|
4163
4409
|
if hasattr(self, 'async_unprovisioning_supported') and self.async_unprovisioning_supported is not None:
|
|
4164
4410
|
_dict['async_unprovisioning_supported'] = self.async_unprovisioning_supported
|
|
4411
|
+
if hasattr(self, 'provision_type') and self.provision_type is not None:
|
|
4412
|
+
_dict['provision_type'] = self.provision_type
|
|
4165
4413
|
if hasattr(self, 'test_check_interval') and self.test_check_interval is not None:
|
|
4166
4414
|
_dict['test_check_interval'] = self.test_check_interval
|
|
4167
4415
|
if hasattr(self, 'single_scope_instance') and self.single_scope_instance is not None:
|
|
@@ -4195,7 +4443,8 @@ class Price:
|
|
|
4195
4443
|
"""
|
|
4196
4444
|
Pricing-related information.
|
|
4197
4445
|
|
|
4198
|
-
:param int quantity_tier: (optional)
|
|
4446
|
+
:param int quantity_tier: (optional) The quantity of _metric_ associated with
|
|
4447
|
+
the current price point.
|
|
4199
4448
|
:param float price: (optional) Price in the selected currency.
|
|
4200
4449
|
"""
|
|
4201
4450
|
|
|
@@ -4208,7 +4457,8 @@ class Price:
|
|
|
4208
4457
|
"""
|
|
4209
4458
|
Initialize a Price object.
|
|
4210
4459
|
|
|
4211
|
-
:param int quantity_tier: (optional)
|
|
4460
|
+
:param int quantity_tier: (optional) The quantity of _metric_ associated
|
|
4461
|
+
with the current price point.
|
|
4212
4462
|
:param float price: (optional) Price in the selected currency.
|
|
4213
4463
|
"""
|
|
4214
4464
|
self.quantity_tier = quantity_tier
|
|
@@ -4265,18 +4515,32 @@ class PricingGet:
|
|
|
4265
4515
|
from. Only set if object kind is deployment.
|
|
4266
4516
|
:param str deployment_location: (optional) The deployment location this pricing
|
|
4267
4517
|
is from. Only set if object kind is deployment.
|
|
4518
|
+
:param str deployment_region: (optional) If price is for a deployment object
|
|
4519
|
+
then the region in the pricing catalog of the deployment object will be here. To
|
|
4520
|
+
be valid, this value must be contained within deployment_regions.
|
|
4268
4521
|
:param bool deployment_location_no_price_available: (optional) Is the location
|
|
4269
4522
|
price not available. Only set in api /pricing/deployment and only set if true.
|
|
4270
4523
|
This means for the given deployment object there was no pricing set in pricing
|
|
4271
4524
|
catalog.
|
|
4272
4525
|
:param str type: (optional) Type of plan. Valid values are `free`, `trial`,
|
|
4273
|
-
`paygo`, `
|
|
4526
|
+
`paygo`, `paid`, `subscription`.
|
|
4274
4527
|
:param str origin: (optional) Defines where the pricing originates.
|
|
4275
4528
|
:param StartingPrice starting_price: (optional) Plan-specific starting price
|
|
4276
4529
|
information.
|
|
4277
4530
|
:param List[Metrics] metrics: (optional) Plan-specific cost metric structure.
|
|
4278
4531
|
:param List[str] deployment_regions: (optional) List of regions where region
|
|
4279
4532
|
pricing is available. Only set on global deployments if enabled by owner.
|
|
4533
|
+
:param datetime effective_from: (optional) The start date-time indicating when
|
|
4534
|
+
this pricing plan takes effect.
|
|
4535
|
+
:param datetime effective_until: (optional) The end date-time indicating when
|
|
4536
|
+
this pricing plan is no longer in effect.
|
|
4537
|
+
:param bool require_login: (optional) Boolean value indicating whether or not
|
|
4538
|
+
this pricing plan requires login to get pricing data.
|
|
4539
|
+
:param str pricing_catalog_url: (optional) URL to the entry for this plan on the
|
|
4540
|
+
pricing catalog.
|
|
4541
|
+
:param List[str] sales_avenue: (optional) Tags describing how this plan was
|
|
4542
|
+
purchased (catalog [default], seller, private offer). Currently only settable on
|
|
4543
|
+
MCSP subscription plans.
|
|
4280
4544
|
"""
|
|
4281
4545
|
|
|
4282
4546
|
def __init__(
|
|
@@ -4284,12 +4548,18 @@ class PricingGet:
|
|
|
4284
4548
|
*,
|
|
4285
4549
|
deployment_id: Optional[str] = None,
|
|
4286
4550
|
deployment_location: Optional[str] = None,
|
|
4551
|
+
deployment_region: Optional[str] = None,
|
|
4287
4552
|
deployment_location_no_price_available: Optional[bool] = None,
|
|
4288
4553
|
type: Optional[str] = None,
|
|
4289
4554
|
origin: Optional[str] = None,
|
|
4290
4555
|
starting_price: Optional['StartingPrice'] = None,
|
|
4291
4556
|
metrics: Optional[List['Metrics']] = None,
|
|
4292
4557
|
deployment_regions: Optional[List[str]] = None,
|
|
4558
|
+
effective_from: Optional[datetime] = None,
|
|
4559
|
+
effective_until: Optional[datetime] = None,
|
|
4560
|
+
require_login: Optional[bool] = None,
|
|
4561
|
+
pricing_catalog_url: Optional[str] = None,
|
|
4562
|
+
sales_avenue: Optional[List[str]] = None,
|
|
4293
4563
|
) -> None:
|
|
4294
4564
|
"""
|
|
4295
4565
|
Initialize a PricingGet object.
|
|
@@ -4298,12 +4568,16 @@ class PricingGet:
|
|
|
4298
4568
|
is from. Only set if object kind is deployment.
|
|
4299
4569
|
:param str deployment_location: (optional) The deployment location this
|
|
4300
4570
|
pricing is from. Only set if object kind is deployment.
|
|
4571
|
+
:param str deployment_region: (optional) If price is for a deployment
|
|
4572
|
+
object then the region in the pricing catalog of the deployment object will
|
|
4573
|
+
be here. To be valid, this value must be contained within
|
|
4574
|
+
deployment_regions.
|
|
4301
4575
|
:param bool deployment_location_no_price_available: (optional) Is the
|
|
4302
4576
|
location price not available. Only set in api /pricing/deployment and only
|
|
4303
4577
|
set if true. This means for the given deployment object there was no
|
|
4304
4578
|
pricing set in pricing catalog.
|
|
4305
4579
|
:param str type: (optional) Type of plan. Valid values are `free`, `trial`,
|
|
4306
|
-
`paygo`, `
|
|
4580
|
+
`paygo`, `paid`, `subscription`.
|
|
4307
4581
|
:param str origin: (optional) Defines where the pricing originates.
|
|
4308
4582
|
:param StartingPrice starting_price: (optional) Plan-specific starting
|
|
4309
4583
|
price information.
|
|
@@ -4312,15 +4586,32 @@ class PricingGet:
|
|
|
4312
4586
|
:param List[str] deployment_regions: (optional) List of regions where
|
|
4313
4587
|
region pricing is available. Only set on global deployments if enabled by
|
|
4314
4588
|
owner.
|
|
4589
|
+
:param datetime effective_from: (optional) The start date-time indicating
|
|
4590
|
+
when this pricing plan takes effect.
|
|
4591
|
+
:param datetime effective_until: (optional) The end date-time indicating
|
|
4592
|
+
when this pricing plan is no longer in effect.
|
|
4593
|
+
:param bool require_login: (optional) Boolean value indicating whether or
|
|
4594
|
+
not this pricing plan requires login to get pricing data.
|
|
4595
|
+
:param str pricing_catalog_url: (optional) URL to the entry for this plan
|
|
4596
|
+
on the pricing catalog.
|
|
4597
|
+
:param List[str] sales_avenue: (optional) Tags describing how this plan was
|
|
4598
|
+
purchased (catalog [default], seller, private offer). Currently only
|
|
4599
|
+
settable on MCSP subscription plans.
|
|
4315
4600
|
"""
|
|
4316
4601
|
self.deployment_id = deployment_id
|
|
4317
4602
|
self.deployment_location = deployment_location
|
|
4603
|
+
self.deployment_region = deployment_region
|
|
4318
4604
|
self.deployment_location_no_price_available = deployment_location_no_price_available
|
|
4319
4605
|
self.type = type
|
|
4320
4606
|
self.origin = origin
|
|
4321
4607
|
self.starting_price = starting_price
|
|
4322
4608
|
self.metrics = metrics
|
|
4323
4609
|
self.deployment_regions = deployment_regions
|
|
4610
|
+
self.effective_from = effective_from
|
|
4611
|
+
self.effective_until = effective_until
|
|
4612
|
+
self.require_login = require_login
|
|
4613
|
+
self.pricing_catalog_url = pricing_catalog_url
|
|
4614
|
+
self.sales_avenue = sales_avenue
|
|
4324
4615
|
|
|
4325
4616
|
@classmethod
|
|
4326
4617
|
def from_dict(cls, _dict: Dict) -> 'PricingGet':
|
|
@@ -4330,6 +4621,8 @@ class PricingGet:
|
|
|
4330
4621
|
args['deployment_id'] = deployment_id
|
|
4331
4622
|
if (deployment_location := _dict.get('deployment_location')) is not None:
|
|
4332
4623
|
args['deployment_location'] = deployment_location
|
|
4624
|
+
if (deployment_region := _dict.get('deployment_region')) is not None:
|
|
4625
|
+
args['deployment_region'] = deployment_region
|
|
4333
4626
|
if (deployment_location_no_price_available := _dict.get('deployment_location_no_price_available')) is not None:
|
|
4334
4627
|
args['deployment_location_no_price_available'] = deployment_location_no_price_available
|
|
4335
4628
|
if (type := _dict.get('type')) is not None:
|
|
@@ -4342,6 +4635,16 @@ class PricingGet:
|
|
|
4342
4635
|
args['metrics'] = [Metrics.from_dict(v) for v in metrics]
|
|
4343
4636
|
if (deployment_regions := _dict.get('deployment_regions')) is not None:
|
|
4344
4637
|
args['deployment_regions'] = deployment_regions
|
|
4638
|
+
if (effective_from := _dict.get('effective_from')) is not None:
|
|
4639
|
+
args['effective_from'] = string_to_datetime(effective_from)
|
|
4640
|
+
if (effective_until := _dict.get('effective_until')) is not None:
|
|
4641
|
+
args['effective_until'] = string_to_datetime(effective_until)
|
|
4642
|
+
if (require_login := _dict.get('require_login')) is not None:
|
|
4643
|
+
args['require_login'] = require_login
|
|
4644
|
+
if (pricing_catalog_url := _dict.get('pricing_catalog_url')) is not None:
|
|
4645
|
+
args['pricing_catalog_url'] = pricing_catalog_url
|
|
4646
|
+
if (sales_avenue := _dict.get('sales_avenue')) is not None:
|
|
4647
|
+
args['sales_avenue'] = sales_avenue
|
|
4345
4648
|
return cls(**args)
|
|
4346
4649
|
|
|
4347
4650
|
@classmethod
|
|
@@ -4356,6 +4659,8 @@ class PricingGet:
|
|
|
4356
4659
|
_dict['deployment_id'] = self.deployment_id
|
|
4357
4660
|
if hasattr(self, 'deployment_location') and self.deployment_location is not None:
|
|
4358
4661
|
_dict['deployment_location'] = self.deployment_location
|
|
4662
|
+
if hasattr(self, 'deployment_region') and self.deployment_region is not None:
|
|
4663
|
+
_dict['deployment_region'] = self.deployment_region
|
|
4359
4664
|
if (
|
|
4360
4665
|
hasattr(self, 'deployment_location_no_price_available')
|
|
4361
4666
|
and self.deployment_location_no_price_available is not None
|
|
@@ -4380,6 +4685,16 @@ class PricingGet:
|
|
|
4380
4685
|
_dict['metrics'] = metrics_list
|
|
4381
4686
|
if hasattr(self, 'deployment_regions') and self.deployment_regions is not None:
|
|
4382
4687
|
_dict['deployment_regions'] = self.deployment_regions
|
|
4688
|
+
if hasattr(self, 'effective_from') and self.effective_from is not None:
|
|
4689
|
+
_dict['effective_from'] = datetime_to_string(self.effective_from)
|
|
4690
|
+
if hasattr(self, 'effective_until') and self.effective_until is not None:
|
|
4691
|
+
_dict['effective_until'] = datetime_to_string(self.effective_until)
|
|
4692
|
+
if hasattr(self, 'require_login') and self.require_login is not None:
|
|
4693
|
+
_dict['require_login'] = self.require_login
|
|
4694
|
+
if hasattr(self, 'pricing_catalog_url') and self.pricing_catalog_url is not None:
|
|
4695
|
+
_dict['pricing_catalog_url'] = self.pricing_catalog_url
|
|
4696
|
+
if hasattr(self, 'sales_avenue') and self.sales_avenue is not None:
|
|
4697
|
+
_dict['sales_avenue'] = self.sales_avenue
|
|
4383
4698
|
return _dict
|
|
4384
4699
|
|
|
4385
4700
|
def _to_dict(self):
|
|
@@ -4552,8 +4867,9 @@ class PricingSet:
|
|
|
4552
4867
|
Pricing-related information.
|
|
4553
4868
|
|
|
4554
4869
|
:param str type: (optional) Type of plan. Valid values are `free`, `trial`,
|
|
4555
|
-
`paygo`, `
|
|
4556
|
-
:param str origin: (optional) Defines where the pricing originates
|
|
4870
|
+
`paygo`, `paid`, `subscription`.
|
|
4871
|
+
:param str origin: (optional) Defines where the pricing originates, either the
|
|
4872
|
+
pricing catalog or the global catalog.
|
|
4557
4873
|
:param StartingPrice starting_price: (optional) Plan-specific starting price
|
|
4558
4874
|
information.
|
|
4559
4875
|
"""
|
|
@@ -4569,8 +4885,9 @@ class PricingSet:
|
|
|
4569
4885
|
Initialize a PricingSet object.
|
|
4570
4886
|
|
|
4571
4887
|
:param str type: (optional) Type of plan. Valid values are `free`, `trial`,
|
|
4572
|
-
`paygo`, `
|
|
4573
|
-
:param str origin: (optional) Defines where the pricing originates
|
|
4888
|
+
`paygo`, `paid`, `subscription`.
|
|
4889
|
+
:param str origin: (optional) Defines where the pricing originates, either
|
|
4890
|
+
the pricing catalog or the global catalog.
|
|
4574
4891
|
:param StartingPrice starting_price: (optional) Plan-specific starting
|
|
4575
4892
|
price information.
|
|
4576
4893
|
"""
|
|
@@ -5121,7 +5438,7 @@ class TemplateMetaData:
|
|
|
5121
5438
|
|
|
5122
5439
|
:param List[str] services: (optional) List of required offering or plan IDs.
|
|
5123
5440
|
:param int default_memory: (optional) Cloud Foundry instance memory value.
|
|
5124
|
-
:param str start_cmd: (optional)
|
|
5441
|
+
:param str start_cmd: (optional) Command used to start a service.
|
|
5125
5442
|
:param SourceMetaData source: (optional) Location of your applications source
|
|
5126
5443
|
files.
|
|
5127
5444
|
:param str runtime_catalog_id: (optional) ID of the runtime.
|
|
@@ -5154,7 +5471,7 @@ class TemplateMetaData:
|
|
|
5154
5471
|
:param List[str] services: (optional) List of required offering or plan
|
|
5155
5472
|
IDs.
|
|
5156
5473
|
:param int default_memory: (optional) Cloud Foundry instance memory value.
|
|
5157
|
-
:param str start_cmd: (optional)
|
|
5474
|
+
:param str start_cmd: (optional) Command used to start a service.
|
|
5158
5475
|
:param SourceMetaData source: (optional) Location of your applications
|
|
5159
5476
|
source files.
|
|
5160
5477
|
:param str runtime_catalog_id: (optional) ID of the runtime.
|
|
@@ -5345,7 +5662,8 @@ class UIMetaData:
|
|
|
5345
5662
|
weight to the UI.
|
|
5346
5663
|
:param datetime end_of_service_time: (optional) Date and time the service will
|
|
5347
5664
|
no longer be available.
|
|
5348
|
-
:param bool hidden: (optional) Denotes visibility.
|
|
5665
|
+
:param bool hidden: (optional) Denotes visibility. Can be set on a
|
|
5666
|
+
service/plan/deployment only by an account with bluemix admin privileges.
|
|
5349
5667
|
:param bool hide_lite_metering: (optional) Denotes lite metering visibility.
|
|
5350
5668
|
:param bool no_upgrade_next_step: (optional) Denotes whether an upgrade should
|
|
5351
5669
|
occur.
|
|
@@ -5391,7 +5709,8 @@ class UIMetaData:
|
|
|
5391
5709
|
weight to the UI.
|
|
5392
5710
|
:param datetime end_of_service_time: (optional) Date and time the service
|
|
5393
5711
|
will no longer be available.
|
|
5394
|
-
:param bool hidden: (optional) Denotes visibility.
|
|
5712
|
+
:param bool hidden: (optional) Denotes visibility. Can be set on a
|
|
5713
|
+
service/plan/deployment only by an account with bluemix admin privileges.
|
|
5395
5714
|
:param bool hide_lite_metering: (optional) Denotes lite metering
|
|
5396
5715
|
visibility.
|
|
5397
5716
|
:param bool no_upgrade_next_step: (optional) Denotes whether an upgrade
|
|
@@ -5616,9 +5935,9 @@ class URLS:
|
|
|
5616
5935
|
:param str sdk_download_url: (optional) URL to downlaod an SDK.
|
|
5617
5936
|
:param str terms_url: (optional) URL to the terms of use for your service.
|
|
5618
5937
|
:param str custom_create_page_url: (optional) URL to the custom create page for
|
|
5619
|
-
your
|
|
5938
|
+
your service.
|
|
5620
5939
|
:param str catalog_details_url: (optional) URL to the catalog details page for
|
|
5621
|
-
your
|
|
5940
|
+
your service.
|
|
5622
5941
|
:param str deprecation_doc_url: (optional) URL for deprecation documentation.
|
|
5623
5942
|
:param str dashboard_url: (optional) URL for dashboard.
|
|
5624
5943
|
:param str registration_url: (optional) URL for registration.
|
|
@@ -5651,9 +5970,9 @@ class URLS:
|
|
|
5651
5970
|
:param str sdk_download_url: (optional) URL to downlaod an SDK.
|
|
5652
5971
|
:param str terms_url: (optional) URL to the terms of use for your service.
|
|
5653
5972
|
:param str custom_create_page_url: (optional) URL to the custom create page
|
|
5654
|
-
for your
|
|
5973
|
+
for your service.
|
|
5655
5974
|
:param str catalog_details_url: (optional) URL to the catalog details page
|
|
5656
|
-
for your
|
|
5975
|
+
for your service.
|
|
5657
5976
|
:param str deprecation_doc_url: (optional) URL for deprecation
|
|
5658
5977
|
documentation.
|
|
5659
5978
|
:param str dashboard_url: (optional) URL for dashboard.
|
|
@@ -5761,19 +6080,21 @@ class Visibility:
|
|
|
5761
6080
|
Information related to the visibility of a catalog entry.
|
|
5762
6081
|
|
|
5763
6082
|
:param str restrictions: (optional) This controls the overall visibility. It is
|
|
5764
|
-
an enum of *public*, *ibm_only*, and *private*. public means it
|
|
5765
|
-
all.
|
|
5766
|
-
|
|
6083
|
+
an enum of *public*, *nonibm_only*, *ibm_only*, and *private*. public means it
|
|
6084
|
+
is visible to all. nonibm_only means it is visible to all except IBM unless
|
|
6085
|
+
their account is explicitly included, ibm_only means it is visible to all IBM
|
|
6086
|
+
unless their account is explicitly excluded. private means it is visible only to
|
|
6087
|
+
the included accounts.
|
|
5767
6088
|
:param str owner: (optional) IAM Scope-related information associated with a
|
|
5768
6089
|
catalog entry.
|
|
5769
|
-
:param bool extendable: (optional) Allows the visibility to be
|
|
6090
|
+
:param bool extendable: (optional) Allows the visibility to be extendable.
|
|
5770
6091
|
:param VisibilityDetail include: (optional) Visibility details related to a
|
|
5771
6092
|
catalog entry.
|
|
5772
6093
|
:param VisibilityDetail exclude: (optional) Visibility details related to a
|
|
5773
6094
|
catalog entry.
|
|
5774
6095
|
:param bool approved: (optional) Determines whether the owning account has full
|
|
5775
6096
|
control over the visibility of the entry such as adding non-IBM accounts to the
|
|
5776
|
-
whitelist and making entries `private`, `ibm_only` or `public`.
|
|
6097
|
+
whitelist and making entries `private`, `nonibm_only`, `ibm_only` or `public`.
|
|
5777
6098
|
"""
|
|
5778
6099
|
|
|
5779
6100
|
def __init__(
|
|
@@ -5789,7 +6110,13 @@ class Visibility:
|
|
|
5789
6110
|
"""
|
|
5790
6111
|
Initialize a Visibility object.
|
|
5791
6112
|
|
|
5792
|
-
:param
|
|
6113
|
+
:param str restrictions: (optional) This controls the overall visibility.
|
|
6114
|
+
It is an enum of *public*, *nonibm_only*, *ibm_only*, and *private*. public
|
|
6115
|
+
means it is visible to all. nonibm_only means it is visible to all except
|
|
6116
|
+
IBM unless their account is explicitly included, ibm_only means it is
|
|
6117
|
+
visible to all IBM unless their account is explicitly excluded. private
|
|
6118
|
+
means it is visible only to the included accounts.
|
|
6119
|
+
:param bool extendable: (optional) Allows the visibility to be extendable.
|
|
5793
6120
|
:param VisibilityDetail include: (optional) Visibility details related to a
|
|
5794
6121
|
catalog entry.
|
|
5795
6122
|
:param VisibilityDetail exclude: (optional) Visibility details related to a
|
|
@@ -5828,8 +6155,8 @@ class Visibility:
|
|
|
5828
6155
|
def to_dict(self) -> Dict:
|
|
5829
6156
|
"""Return a json dictionary representing this model."""
|
|
5830
6157
|
_dict = {}
|
|
5831
|
-
if hasattr(self, 'restrictions') and
|
|
5832
|
-
_dict['restrictions'] =
|
|
6158
|
+
if hasattr(self, 'restrictions') and self.restrictions is not None:
|
|
6159
|
+
_dict['restrictions'] = self.restrictions
|
|
5833
6160
|
if hasattr(self, 'owner') and getattr(self, 'owner') is not None:
|
|
5834
6161
|
_dict['owner'] = getattr(self, 'owner')
|
|
5835
6162
|
if hasattr(self, 'extendable') and self.extendable is not None:
|