otcextensions.sdk.dcs.v1.az

The DMS Availability Zone Class

The AvailabilityZone class inherits from Resource.

class otcextensions.sdk.dms.v1.az.AvailabilityZone(_synchronized=False, connection=None, **attrs)

DMS AZ resource

The base resource

Parameters:

  • _synchronized (bool) – This is not intended to be used directly. See new() and existing().

  • connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of self._connection in Resource code should protect itself with a check for None.

resources_key: ty.Optional[str] = 'available_zones'

Plural form of key for resource.

base_path: str = '/availableZones'

The base part of the URI for this resource.

allow_list = True

Allow list operation for this resource.

code

Properties AZ code

has_available_resources

Has free resources

port

Port number

region_id

Region ID

classmethod list(session, **params)

This method is a generator which yields resource objects.

This resource object list generator handles pagination and takes query params for response filtering.

Parameters:

  • session (Adapter) – The session to use for making this request.

  • paginated (bool) – True if a GET to this resource returns a paginated series of responses, or False if a GET returns only one page of data. When paginated is False only one page of data will be returned regardless of the API’s support of pagination.

  • base_path (str) – Base part of the URI for listing resources, if different from base_path.

  • allow_unknown_params (bool) – True to accept, but discard unknown query parameters. This allows getting list of ‘filters’ and passing everything known to the server. False will result in validation exception when unknown query parameters are passed.

  • microversion (str) – API version to override the negotiated one.

  • headers (dict) – Additional headers to inject into the HTTP request.

  • params (dict) – These keyword arguments are passed through the _transpose() method to find if any of them match expected query parameters to be sent in the params argument to get(). They are additionally checked against the base_path format string to see if any path fragments need to be filled in by the contents of this argument. Parameters supported as filters by the server side are passed in the API call, remaining parameters are applied as filters to the retrieved results.

Returns:

A generator of Resource objects.

Raises:

MethodNotSupported if Resource.allow_list is not set to True.

Raises:

InvalidResourceQuery if query contains invalid params.

otcextensions.sdk.dcs.v1.product

The DMS Product Spec Class

The Product class inherits from Resource.

class otcextensions.sdk.dms.v1.product.Product(_synchronized=False, connection=None, **attrs)

DMS Product resource

The base resource

Parameters:

  • _synchronized (bool) – This is not intended to be used directly. See new() and existing().

  • connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of self._connection in Resource code should protect itself with a check for None.

base_path: str = '/products'

The base part of the URI for this resource.

resources_key: ty.Optional[str] = 'Hourly'

Plural form of key for resource.

allow_list = True

Allow list operation for this resource.

engine_name

Properties

tps

Indicates the maximum number of messages per unit time.

storage

Indicates the message storage space.

partition_num

Indicates the maximum number of topics in a Kafka instance.

product_id

Indicates the product ID.

spec_code

Indicates the specification ID.

io

Indicates the I/O information.

bandwidth

Indicates the bandwidth of a Kafka instance.

availability_zones

Indicates AZs where there are available resources.

unavailable_zones

Indicated AZs where it is not available

vm_flavor_id

Indicates the VM specifications of the instance resources.

arch_type

Indicates the instance architecture type. Currently, only x86 is supported.

classmethod list(session, **params)

This method is a generator which yields resource objects.

This resource object list generator handles pagination and takes query params for response filtering.

Parameters:

  • session (Adapter) – The session to use for making this request.

  • paginated (bool) – True if a GET to this resource returns a paginated series of responses, or False if a GET returns only one page of data. When paginated is False only one page of data will be returned regardless of the API’s support of pagination.

  • base_path (str) – Base part of the URI for listing resources, if different from base_path.

  • allow_unknown_params (bool) – True to accept, but discard unknown query parameters. This allows getting list of ‘filters’ and passing everything known to the server. False will result in validation exception when unknown query parameters are passed.

  • microversion (str) – API version to override the negotiated one.

  • headers (dict) – Additional headers to inject into the HTTP request.

  • params (dict) – These keyword arguments are passed through the _transpose() method to find if any of them match expected query parameters to be sent in the params argument to get(). They are additionally checked against the base_path format string to see if any path fragments need to be filled in by the contents of this argument. Parameters supported as filters by the server side are passed in the API call, remaining parameters are applied as filters to the retrieved results.

Returns:

A generator of Resource objects.

Raises:

MethodNotSupported if Resource.allow_list is not set to True.

Raises:

InvalidResourceQuery if query contains invalid params.

otcextensions.sdk.dcs.v1.maintenance_window

The DMS Maintenance window Class

The MaintenanceWindow class inherits from Resource.

class otcextensions.sdk.dms.v1.maintenance_window.MaintenanceWindow(_synchronized=False, connection=None, **attrs)

DMS Maintenance window resource

The base resource

Parameters:

  • _synchronized (bool) – This is not intended to be used directly. See new() and existing().

  • connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of self._connection in Resource code should protect itself with a check for None.

resources_key: ty.Optional[str] = 'maintain_windows'

Plural form of key for resource.

base_path: str = '/instances/maintain-windows'

The base part of the URI for this resource.

allow_list = True

Allow list operation for this resource.

seq

Properties Indicates the sequential number of a maintenance time window.

begin

Indicates the time at which a maintenance time window starts.

end

Indicates the time at which a maintenance time window ends.

is_default

Indicates whether a maintenance time window is set to the default time segment.

classmethod list(session, **params)

This method is a generator which yields resource objects.

This resource object list generator handles pagination and takes query params for response filtering.

Parameters:

  • session (Adapter) – The session to use for making this request.

  • paginated (bool) – True if a GET to this resource returns a paginated series of responses, or False if a GET returns only one page of data. When paginated is False only one page of data will be returned regardless of the API’s support of pagination.

  • base_path (str) – Base part of the URI for listing resources, if different from base_path.

  • allow_unknown_params (bool) – True to accept, but discard unknown query parameters. This allows getting list of ‘filters’ and passing everything known to the server. False will result in validation exception when unknown query parameters are passed.

  • microversion (str) – API version to override the negotiated one.

  • headers (dict) – Additional headers to inject into the HTTP request.

  • params (dict) – These keyword arguments are passed through the _transpose() method to find if any of them match expected query parameters to be sent in the params argument to get(). They are additionally checked against the base_path format string to see if any path fragments need to be filled in by the contents of this argument. Parameters supported as filters by the server side are passed in the API call, remaining parameters are applied as filters to the retrieved results.

Returns:

A generator of Resource objects.

Raises:

MethodNotSupported if Resource.allow_list is not set to True.

Raises:

InvalidResourceQuery if query contains invalid params.

last updated: UTC - commit: