diff --git a/CHANGELOG.rst b/CHANGELOG.rst index b03bdb35a4..54360ce30a 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file. The format is based on `Keep a Changelog `_. +==================== +2.0.3 -2018-09-06 +==================== + +Added +----- +* Added support for updating metadata fields on an instance in the Compute service + +Fixed +------- +* Fixed example wait_for_resource_in_state.py to use existing response objects. The updated example can be found on `GitHub `__. + ==================== 2.0.2 - 2018-08-23 ==================== diff --git a/requirements.txt b/requirements.txt index a1666f47cf..fe73a46c66 100755 --- a/requirements.txt +++ b/requirements.txt @@ -7,6 +7,7 @@ mock==2.0.0 pyOpenSSL==17.4.0 pytest==3.2.3 pytest-catchlog==1.2.2 +pytest-cov==2.5.1 python-dateutil>=2.5.3,<=2.7.3 pytz>=2016.10 sphinx-rtd-theme==0.2.5b2 diff --git a/setup.py b/setup.py index d946c1ca9f..631cc23b74 100644 --- a/setup.py +++ b/setup.py @@ -30,7 +30,7 @@ def open_relative(*path): requires = [ "certifi", - "configparser==3.5.0", + "configparser>=3.5.0b1", "cryptography>=2.1.3", "pyOpenSSL<=17.4.0", "python-dateutil>=2.5.3,<=2.7.3", diff --git a/src/oci/core/blockstorage_client.py b/src/oci/core/blockstorage_client.py index f67f2b807b..ecbe2e6623 100644 --- a/src/oci/core/blockstorage_client.py +++ b/src/oci/core/blockstorage_client.py @@ -236,11 +236,11 @@ def create_volume(self, create_volume_details, **kwargs): For general information about block volumes, see `Overview of Block Volume Service`__. - A volume and instance can be in separate compartments but must be in the same Availability Domain. + A volume and instance can be in separate compartments but must be in the same availability domain. For information about access control and compartments, see `Overview of the IAM Service`__. For information about - Availability Domains, see `Regions and Availability Domains`__. - To get a list of Availability Domains, use the `ListAvailabilityDomains` operation + availability domains, see `Regions and Availability Domains`__. + To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API. You may optionally specify a *display name* for the volume, which is simply a friendly name or @@ -1742,9 +1742,9 @@ def list_boot_volume_backups(self, compartment_id, **kwargs): sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you - optionally filter by Availability Domain if the scope of the resource type is within a - single Availability Domain. If you call one of these \"List\" operations without specifying - an Availability Domain, the resources are grouped by Availability Domain, then sorted. + optionally filter by availability domain if the scope of the resource type is within a + single availability domain. If you call one of these \"List\" operations without specifying + an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: "TIMECREATED", "DISPLAYNAME" @@ -1850,11 +1850,11 @@ def list_boot_volume_backups(self, compartment_id, **kwargs): def list_boot_volumes(self, availability_domain, compartment_id, **kwargs): """ ListBootVolumes - Lists the boot volumes in the specified compartment and Availability Domain. + Lists the boot volumes in the specified compartment and availability domain. :param str availability_domain: (required) - The name of the Availability Domain. + The name of the availability domain. Example: `Uocm:PHX-AD-1` @@ -2031,9 +2031,9 @@ def list_volume_backups(self, compartment_id, **kwargs): sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you - optionally filter by Availability Domain if the scope of the resource type is within a - single Availability Domain. If you call one of these \"List\" operations without specifying - an Availability Domain, the resources are grouped by Availability Domain, then sorted. + optionally filter by availability domain if the scope of the resource type is within a + single availability domain. If you call one of these \"List\" operations without specifying + an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: "TIMECREATED", "DISPLAYNAME" @@ -2168,9 +2168,9 @@ def list_volume_group_backups(self, compartment_id, **kwargs): sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you - optionally filter by Availability Domain if the scope of the resource type is within a - single Availability Domain. If you call one of these \"List\" operations without specifying - an Availability Domain, the resources are grouped by Availability Domain, then sorted. + optionally filter by availability domain if the scope of the resource type is within a + single availability domain. If you call one of these \"List\" operations without specifying + an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: "TIMECREATED", "DISPLAYNAME" @@ -2272,7 +2272,7 @@ def list_volume_groups(self, compartment_id, **kwargs): The OCID of the compartment. :param str availability_domain: (optional) - The name of the Availability Domain. + The name of the availability domain. Example: `Uocm:PHX-AD-1` @@ -2293,9 +2293,9 @@ def list_volume_groups(self, compartment_id, **kwargs): sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you - optionally filter by Availability Domain if the scope of the resource type is within a - single Availability Domain. If you call one of these \"List\" operations without specifying - an Availability Domain, the resources are grouped by Availability Domain, then sorted. + optionally filter by availability domain if the scope of the resource type is within a + single availability domain. If you call one of these \"List\" operations without specifying + an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: "TIMECREATED", "DISPLAYNAME" @@ -2401,14 +2401,14 @@ def list_volume_groups(self, compartment_id, **kwargs): def list_volumes(self, compartment_id, **kwargs): """ ListVolumes - Lists the volumes in the specified compartment and Availability Domain. + Lists the volumes in the specified compartment and availability domain. :param str compartment_id: (required) The OCID of the compartment. :param str availability_domain: (optional) - The name of the Availability Domain. + The name of the availability domain. Example: `Uocm:PHX-AD-1` @@ -2429,9 +2429,9 @@ def list_volumes(self, compartment_id, **kwargs): sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you - optionally filter by Availability Domain if the scope of the resource type is within a - single Availability Domain. If you call one of these \"List\" operations without specifying - an Availability Domain, the resources are grouped by Availability Domain, then sorted. + optionally filter by availability domain if the scope of the resource type is within a + single availability domain. If you call one of these \"List\" operations without specifying + an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: "TIMECREATED", "DISPLAYNAME" diff --git a/src/oci/core/compute_client.py b/src/oci/core/compute_client.py index 309a4751d2..74a6c97d23 100644 --- a/src/oci/core/compute_client.py +++ b/src/oci/core/compute_client.py @@ -1820,16 +1820,16 @@ def instance_action(self, instance_id, action, **kwargs): def launch_instance(self, launch_instance_details, **kwargs): """ LaunchInstance - Creates a new instance in the specified compartment and the specified Availability Domain. + Creates a new instance in the specified compartment and the specified availability domain. For general information about instances, see `Overview of the Compute Service`__. For information about access control and compartments, see `Overview of the IAM Service`__. - For information about Availability Domains, see + For information about availability domains, see `Regions and Availability Domains`__. - To get a list of Availability Domains, use the `ListAvailabilityDomains` operation + To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API. All Oracle Cloud Infrastructure resources, including instances, get an Oracle-assigned, @@ -1929,7 +1929,7 @@ def list_boot_volume_attachments(self, availability_domain, compartment_id, **kw :param str availability_domain: (required) - The name of the Availability Domain. + The name of the availability domain. Example: `Uocm:PHX-AD-1` @@ -2022,7 +2022,7 @@ def list_console_histories(self, compartment_id, **kwargs): The OCID of the compartment. :param str availability_domain: (optional) - The name of the Availability Domain. + The name of the availability domain. Example: `Uocm:PHX-AD-1` @@ -2043,9 +2043,9 @@ def list_console_histories(self, compartment_id, **kwargs): sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you - optionally filter by Availability Domain if the scope of the resource type is within a - single Availability Domain. If you call one of these \"List\" operations without specifying - an Availability Domain, the resources are grouped by Availability Domain, then sorted. + optionally filter by availability domain if the scope of the resource type is within a + single availability domain. If you call one of these \"List\" operations without specifying + an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: "TIMECREATED", "DISPLAYNAME" @@ -2196,9 +2196,9 @@ def list_images(self, compartment_id, **kwargs): sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you - optionally filter by Availability Domain if the scope of the resource type is within a - single Availability Domain. If you call one of these \"List\" operations without specifying - an Availability Domain, the resources are grouped by Availability Domain, then sorted. + optionally filter by availability domain if the scope of the resource type is within a + single availability domain. If you call one of these \"List\" operations without specifying + an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: "TIMECREATED", "DISPLAYNAME" @@ -2391,7 +2391,7 @@ def list_instance_console_connections(self, compartment_id, **kwargs): def list_instances(self, compartment_id, **kwargs): """ ListInstances - Lists the instances in the specified compartment and the specified Availability Domain. + Lists the instances in the specified compartment and the specified availability domain. You can filter the results by specifying an instance name (the list will include all the identically-named instances in the compartment). @@ -2400,7 +2400,7 @@ def list_instances(self, compartment_id, **kwargs): The OCID of the compartment. :param str availability_domain: (optional) - The name of the Availability Domain. + The name of the availability domain. Example: `Uocm:PHX-AD-1` @@ -2421,9 +2421,9 @@ def list_instances(self, compartment_id, **kwargs): sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you - optionally filter by Availability Domain if the scope of the resource type is within a - single Availability Domain. If you call one of these \"List\" operations without specifying - an Availability Domain, the resources are grouped by Availability Domain, then sorted. + optionally filter by availability domain if the scope of the resource type is within a + single availability domain. If you call one of these \"List\" operations without specifying + an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: "TIMECREATED", "DISPLAYNAME" @@ -2537,7 +2537,7 @@ def list_shapes(self, compartment_id, **kwargs): The OCID of the compartment. :param str availability_domain: (optional) - The name of the Availability Domain. + The name of the availability domain. Example: `Uocm:PHX-AD-1` @@ -2618,14 +2618,14 @@ def list_vnic_attachments(self, compartment_id, **kwargs): ListVnicAttachments Lists the VNIC attachments in the specified compartment. A VNIC attachment resides in the same compartment as the attached instance. The list can be - filtered by instance, VNIC, or Availability Domain. + filtered by instance, VNIC, or availability domain. :param str compartment_id: (required) The OCID of the compartment. :param str availability_domain: (optional) - The name of the Availability Domain. + The name of the availability domain. Example: `Uocm:PHX-AD-1` @@ -2720,7 +2720,7 @@ def list_volume_attachments(self, compartment_id, **kwargs): The OCID of the compartment. :param str availability_domain: (optional) - The name of the Availability Domain. + The name of the availability domain. Example: `Uocm:PHX-AD-1` @@ -3067,7 +3067,12 @@ def update_image(self, image_id, update_image_details, **kwargs): def update_instance(self, instance_id, update_instance_details, **kwargs): """ UpdateInstance - Updates the display name of the specified instance. Avoid entering confidential information. + Updates certain fields on the specified instance. Fields that are not provided in the + request will not be updated. Avoid entering confidential information. + + Changes to metadata fields will be reflected in the instance metadata service (this may take + up to a minute). + The OCID of the instance remains the same. diff --git a/src/oci/core/models/boot_volume.py b/src/oci/core/models/boot_volume.py index 99501a9ed7..cce5a2d852 100644 --- a/src/oci/core/models/boot_volume.py +++ b/src/oci/core/models/boot_volume.py @@ -16,6 +16,9 @@ class BootVolume(object): talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/bootvolumes.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ @@ -161,7 +164,7 @@ def __init__(self, **kwargs): def availability_domain(self): """ **[Required]** Gets the availability_domain of this BootVolume. - The Availability Domain of the boot volume. + The availability domain of the boot volume. Example: `Uocm:PHX-AD-1` @@ -175,7 +178,7 @@ def availability_domain(self): def availability_domain(self, availability_domain): """ Sets the availability_domain of this BootVolume. - The Availability Domain of the boot volume. + The availability domain of the boot volume. Example: `Uocm:PHX-AD-1` @@ -461,7 +464,7 @@ def size_in_mbs(self, size_in_mbs): def source_details(self): """ Gets the source_details of this BootVolume. - The boot volume source, either an existing boot volume in the same Availability Domain or a boot volume backup. + The boot volume source, either an existing boot volume in the same availability domain or a boot volume backup. If null, this means that the boot volume was created from an image. @@ -474,7 +477,7 @@ def source_details(self): def source_details(self, source_details): """ Sets the source_details of this BootVolume. - The boot volume source, either an existing boot volume in the same Availability Domain or a boot volume backup. + The boot volume source, either an existing boot volume in the same availability domain or a boot volume backup. If null, this means that the boot volume was created from an image. diff --git a/src/oci/core/models/boot_volume_attachment.py b/src/oci/core/models/boot_volume_attachment.py index 4256221133..e9b3886b26 100644 --- a/src/oci/core/models/boot_volume_attachment.py +++ b/src/oci/core/models/boot_volume_attachment.py @@ -10,6 +10,9 @@ class BootVolumeAttachment(object): """ Represents an attachment between a boot volume and an instance. + + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. """ #: A constant which can be used with the lifecycle_state property of a BootVolumeAttachment. @@ -103,7 +106,7 @@ def __init__(self, **kwargs): def availability_domain(self): """ **[Required]** Gets the availability_domain of this BootVolumeAttachment. - The Availability Domain of an instance. + The availability domain of an instance. Example: `Uocm:PHX-AD-1` @@ -117,7 +120,7 @@ def availability_domain(self): def availability_domain(self, availability_domain): """ Sets the availability_domain of this BootVolumeAttachment. - The Availability Domain of an instance. + The availability domain of an instance. Example: `Uocm:PHX-AD-1` diff --git a/src/oci/core/models/boot_volume_backup.py b/src/oci/core/models/boot_volume_backup.py index 471549ff8b..f224f7f8d5 100644 --- a/src/oci/core/models/boot_volume_backup.py +++ b/src/oci/core/models/boot_volume_backup.py @@ -17,6 +17,9 @@ class BootVolumeBackup(object): who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/bootvolumebackups.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ diff --git a/src/oci/core/models/console_history.py b/src/oci/core/models/console_history.py index ac318407b7..ccc365ff30 100644 --- a/src/oci/core/models/console_history.py +++ b/src/oci/core/models/console_history.py @@ -12,6 +12,9 @@ class ConsoleHistory(object): An instance's serial console data. It includes configuration messages that occur when the instance boots, such as kernel and BIOS messages, and is useful for checking the status of the instance or diagnosing problems. The console data is minimally formatted ASCII text. + + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. """ #: A constant which can be used with the lifecycle_state property of a ConsoleHistory. @@ -112,7 +115,7 @@ def __init__(self, **kwargs): def availability_domain(self): """ **[Required]** Gets the availability_domain of this ConsoleHistory. - The Availability Domain of an instance. + The availability domain of an instance. Example: `Uocm:PHX-AD-1` @@ -126,7 +129,7 @@ def availability_domain(self): def availability_domain(self, availability_domain): """ Sets the availability_domain of this ConsoleHistory. - The Availability Domain of an instance. + The availability domain of an instance. Example: `Uocm:PHX-AD-1` diff --git a/src/oci/core/models/cpe.py b/src/oci/core/models/cpe.py index 5f29a2ca62..050125cfdb 100644 --- a/src/oci/core/models/cpe.py +++ b/src/oci/core/models/cpe.py @@ -10,7 +10,7 @@ class Cpe(object): """ An object you create when setting up an IPSec VPN between your on-premises network - and VCN. The `Cpe` is a virtual representation of your Customer-Premises Equipment, + and VCN. The `Cpe` is a virtual representation of your customer-premises equipment, which is the actual router on-premises at your site at your end of the IPSec VPN connection. For more information, see `Overview of the Networking Service`__. @@ -19,6 +19,9 @@ class Cpe(object): talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ diff --git a/src/oci/core/models/create_boot_volume_details.py b/src/oci/core/models/create_boot_volume_details.py index 15d79b91e7..ad7b97ef4a 100644 --- a/src/oci/core/models/create_boot_volume_details.py +++ b/src/oci/core/models/create_boot_volume_details.py @@ -85,7 +85,7 @@ def __init__(self, **kwargs): def availability_domain(self): """ **[Required]** Gets the availability_domain of this CreateBootVolumeDetails. - The Availability Domain of the boot volume. + The availability domain of the boot volume. Example: `Uocm:PHX-AD-1` @@ -99,7 +99,7 @@ def availability_domain(self): def availability_domain(self, availability_domain): """ Sets the availability_domain of this CreateBootVolumeDetails. - The Availability Domain of the boot volume. + The availability domain of the boot volume. Example: `Uocm:PHX-AD-1` @@ -283,7 +283,7 @@ def size_in_gbs(self, size_in_gbs): def source_details(self): """ **[Required]** Gets the source_details of this CreateBootVolumeDetails. - Specifies the boot volume source details for a new boot volume. The volume source is either another boot volume in the same Availability Domain or a boot volume backup. + Specifies the boot volume source details for a new boot volume. The volume source is either another boot volume in the same availability domain or a boot volume backup. This is a mandatory field for a boot volume. @@ -296,7 +296,7 @@ def source_details(self): def source_details(self, source_details): """ Sets the source_details of this CreateBootVolumeDetails. - Specifies the boot volume source details for a new boot volume. The volume source is either another boot volume in the same Availability Domain or a boot volume backup. + Specifies the boot volume source details for a new boot volume. The volume source is either another boot volume in the same availability domain or a boot volume backup. This is a mandatory field for a boot volume. diff --git a/src/oci/core/models/create_internet_gateway_details.py b/src/oci/core/models/create_internet_gateway_details.py index 6bfd83e3b9..16d2c299c2 100644 --- a/src/oci/core/models/create_internet_gateway_details.py +++ b/src/oci/core/models/create_internet_gateway_details.py @@ -71,7 +71,7 @@ def __init__(self, **kwargs): def compartment_id(self): """ **[Required]** Gets the compartment_id of this CreateInternetGatewayDetails. - The OCID of the compartment to contain the Internet Gateway. + The OCID of the compartment to contain the internet gateway. :return: The compartment_id of this CreateInternetGatewayDetails. @@ -83,7 +83,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this CreateInternetGatewayDetails. - The OCID of the compartment to contain the Internet Gateway. + The OCID of the compartment to contain the internet gateway. :param compartment_id: The compartment_id of this CreateInternetGatewayDetails. @@ -213,7 +213,7 @@ def is_enabled(self, is_enabled): def vcn_id(self): """ **[Required]** Gets the vcn_id of this CreateInternetGatewayDetails. - The OCID of the VCN the Internet Gateway is attached to. + The OCID of the VCN the internet gateway is attached to. :return: The vcn_id of this CreateInternetGatewayDetails. @@ -225,7 +225,7 @@ def vcn_id(self): def vcn_id(self, vcn_id): """ Sets the vcn_id of this CreateInternetGatewayDetails. - The OCID of the VCN the Internet Gateway is attached to. + The OCID of the VCN the internet gateway is attached to. :param vcn_id: The vcn_id of this CreateInternetGatewayDetails. diff --git a/src/oci/core/models/create_service_gateway_details.py b/src/oci/core/models/create_service_gateway_details.py index 137f19959e..e39e8f625b 100644 --- a/src/oci/core/models/create_service_gateway_details.py +++ b/src/oci/core/models/create_service_gateway_details.py @@ -71,7 +71,7 @@ def __init__(self, **kwargs): def compartment_id(self): """ **[Required]** Gets the compartment_id of this CreateServiceGatewayDetails. - The `OCID]`__ of the compartment to contain the Service Gateway. + The `OCID]`__ of the compartment to contain the service gateway. __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm @@ -85,7 +85,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this CreateServiceGatewayDetails. - The `OCID]`__ of the compartment to contain the Service Gateway. + The `OCID]`__ of the compartment to contain the service gateway. __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm @@ -195,7 +195,7 @@ def freeform_tags(self, freeform_tags): def services(self): """ **[Required]** Gets the services of this CreateServiceGatewayDetails. - List of the Service OCIDs. These are the Services which will be enabled on the Service Gateway. This list can be empty. + List of the service OCIDs. These are the services that will be enabled on the service gateway. This list can be empty. :return: The services of this CreateServiceGatewayDetails. @@ -207,7 +207,7 @@ def services(self): def services(self, services): """ Sets the services of this CreateServiceGatewayDetails. - List of the Service OCIDs. These are the Services which will be enabled on the Service Gateway. This list can be empty. + List of the service OCIDs. These are the services that will be enabled on the service gateway. This list can be empty. :param services: The services of this CreateServiceGatewayDetails. diff --git a/src/oci/core/models/create_subnet_details.py b/src/oci/core/models/create_subnet_details.py index 92b47ce34e..6d9a7969c1 100644 --- a/src/oci/core/models/create_subnet_details.py +++ b/src/oci/core/models/create_subnet_details.py @@ -113,7 +113,7 @@ def __init__(self, **kwargs): def availability_domain(self): """ **[Required]** Gets the availability_domain of this CreateSubnetDetails. - The Availability Domain to contain the subnet. + The availability domain to contain the subnet. Example: `Uocm:PHX-AD-1` @@ -127,7 +127,7 @@ def availability_domain(self): def availability_domain(self, availability_domain): """ Sets the availability_domain of this CreateSubnetDetails. - The Availability Domain to contain the subnet. + The availability domain to contain the subnet. Example: `Uocm:PHX-AD-1` diff --git a/src/oci/core/models/create_volume_details.py b/src/oci/core/models/create_volume_details.py index db19e38e3f..6f4066cfca 100644 --- a/src/oci/core/models/create_volume_details.py +++ b/src/oci/core/models/create_volume_details.py @@ -99,7 +99,7 @@ def __init__(self, **kwargs): def availability_domain(self): """ **[Required]** Gets the availability_domain of this CreateVolumeDetails. - The Availability Domain of the volume. + The availability domain of the volume. Example: `Uocm:PHX-AD-1` @@ -113,7 +113,7 @@ def availability_domain(self): def availability_domain(self, availability_domain): """ Sets the availability_domain of this CreateVolumeDetails. - The Availability Domain of the volume. + The availability domain of the volume. Example: `Uocm:PHX-AD-1` @@ -323,7 +323,7 @@ def size_in_mbs(self, size_in_mbs): def source_details(self): """ Gets the source_details of this CreateVolumeDetails. - Specifies the volume source details for a new Block volume. The volume source is either another Block volume in the same Availability Domain or a Block volume backup. + Specifies the volume source details for a new Block volume. The volume source is either another Block volume in the same availability domain or a Block volume backup. This is an optional field. If not specified or set to null, the new Block volume will be empty. When specified, the new Block volume will contain data from the source volume or backup. @@ -337,7 +337,7 @@ def source_details(self): def source_details(self, source_details): """ Sets the source_details of this CreateVolumeDetails. - Specifies the volume source details for a new Block volume. The volume source is either another Block volume in the same Availability Domain or a Block volume backup. + Specifies the volume source details for a new Block volume. The volume source is either another Block volume in the same availability domain or a Block volume backup. This is an optional field. If not specified or set to null, the new Block volume will be empty. When specified, the new Block volume will contain data from the source volume or backup. diff --git a/src/oci/core/models/create_volume_group_details.py b/src/oci/core/models/create_volume_group_details.py index 743fe041d6..8e5a768b23 100644 --- a/src/oci/core/models/create_volume_group_details.py +++ b/src/oci/core/models/create_volume_group_details.py @@ -71,7 +71,7 @@ def __init__(self, **kwargs): def availability_domain(self): """ **[Required]** Gets the availability_domain of this CreateVolumeGroupDetails. - The Availability Domain of the volume group. + The availability domain of the volume group. :return: The availability_domain of this CreateVolumeGroupDetails. @@ -83,7 +83,7 @@ def availability_domain(self): def availability_domain(self, availability_domain): """ Sets the availability_domain of this CreateVolumeGroupDetails. - The Availability Domain of the volume group. + The availability domain of the volume group. :param availability_domain: The availability_domain of this CreateVolumeGroupDetails. @@ -214,7 +214,7 @@ def source_details(self): """ **[Required]** Gets the source_details of this CreateVolumeGroupDetails. Specifies the volume group source details for a new volume group. The volume source is either another a list of - volume ids in the same Availability Domain, another volume group or a volume group backup. + volume ids in the same availability domain, another volume group or a volume group backup. :return: The source_details of this CreateVolumeGroupDetails. @@ -227,7 +227,7 @@ def source_details(self, source_details): """ Sets the source_details of this CreateVolumeGroupDetails. Specifies the volume group source details for a new volume group. The volume source is either another a list of - volume ids in the same Availability Domain, another volume group or a volume group backup. + volume ids in the same availability domain, another volume group or a volume group backup. :param source_details: The source_details of this CreateVolumeGroupDetails. diff --git a/src/oci/core/models/cross_connect.py b/src/oci/core/models/cross_connect.py index 6e4bd1131a..77596afe0a 100644 --- a/src/oci/core/models/cross_connect.py +++ b/src/oci/core/models/cross_connect.py @@ -26,6 +26,9 @@ class CrossConnect(object): talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ diff --git a/src/oci/core/models/cross_connect_group.py b/src/oci/core/models/cross_connect_group.py index aa428f4489..282c710e54 100644 --- a/src/oci/core/models/cross_connect_group.py +++ b/src/oci/core/models/cross_connect_group.py @@ -23,6 +23,9 @@ class CrossConnectGroup(object): talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ diff --git a/src/oci/core/models/dhcp_dns_option.py b/src/oci/core/models/dhcp_dns_option.py index 7d0b23ebc0..e3a34e3579 100644 --- a/src/oci/core/models/dhcp_dns_option.py +++ b/src/oci/core/models/dhcp_dns_option.py @@ -70,8 +70,8 @@ def __init__(self, **kwargs): def custom_dns_servers(self): """ Gets the custom_dns_servers of this DhcpDnsOption. - If you set `serverType` to `CustomDnsServer`, specify the IP address - of at least one DNS server of your choice (three maximum). + If you set `serverType` to `CustomDnsServer`, specify the + IP address of at least one DNS server of your choice (three maximum). gd :return: The custom_dns_servers of this DhcpDnsOption. @@ -83,8 +83,8 @@ def custom_dns_servers(self): def custom_dns_servers(self, custom_dns_servers): """ Sets the custom_dns_servers of this DhcpDnsOption. - If you set `serverType` to `CustomDnsServer`, specify the IP address - of at least one DNS server of your choice (three maximum). + If you set `serverType` to `CustomDnsServer`, specify the + IP address of at least one DNS server of your choice (three maximum). gd :param custom_dns_servers: The custom_dns_servers of this DhcpDnsOption. @@ -96,10 +96,10 @@ def custom_dns_servers(self, custom_dns_servers): def server_type(self): """ **[Required]** Gets the server_type of this DhcpDnsOption. - - **VcnLocal:** Reserved for future use. + * **VcnLocal:** Reserved for future use. - - **VcnLocalPlusInternet:** Also referred to as \"Internet and VCN Resolver\". - Instances can resolve internet hostnames (no Internet Gateway is required), + * **VcnLocalPlusInternet:** Also referred to as \"Internet and VCN Resolver\". + Instances can resolve internet hostnames (no internet gateway is required), and can resolve hostnames of instances in the VCN. This is the default value in the default set of DHCP options in the VCN. For the Internet and VCN Resolver to work across the VCN, there must also be a DNS label set for @@ -109,7 +109,8 @@ def server_type(self): information, see `DNS in Your Virtual Cloud Network`__. - - **CustomDnsServer:** Instances use a DNS server of your choice (three maximum). + * **CustomDnsServer:** Instances use a DNS server of your choice (three + maximum). __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm @@ -126,10 +127,10 @@ def server_type(self): def server_type(self, server_type): """ Sets the server_type of this DhcpDnsOption. - - **VcnLocal:** Reserved for future use. + * **VcnLocal:** Reserved for future use. - - **VcnLocalPlusInternet:** Also referred to as \"Internet and VCN Resolver\". - Instances can resolve internet hostnames (no Internet Gateway is required), + * **VcnLocalPlusInternet:** Also referred to as \"Internet and VCN Resolver\". + Instances can resolve internet hostnames (no internet gateway is required), and can resolve hostnames of instances in the VCN. This is the default value in the default set of DHCP options in the VCN. For the Internet and VCN Resolver to work across the VCN, there must also be a DNS label set for @@ -139,7 +140,8 @@ def server_type(self, server_type): information, see `DNS in Your Virtual Cloud Network`__. - - **CustomDnsServer:** Instances use a DNS server of your choice (three maximum). + * **CustomDnsServer:** Instances use a DNS server of your choice (three + maximum). __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm diff --git a/src/oci/core/models/dhcp_options.py b/src/oci/core/models/dhcp_options.py index 058a5a09e1..bb6629832e 100644 --- a/src/oci/core/models/dhcp_options.py +++ b/src/oci/core/models/dhcp_options.py @@ -25,6 +25,9 @@ class DhcpOptions(object): talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingDHCP.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm diff --git a/src/oci/core/models/drg.py b/src/oci/core/models/drg.py index ec6190e54d..94c450c0eb 100644 --- a/src/oci/core/models/drg.py +++ b/src/oci/core/models/drg.py @@ -9,7 +9,7 @@ @init_model_state_from_kwargs class Drg(object): """ - A Dynamic Routing Gateway (DRG), which is a virtual router that provides a path for private + A dynamic routing gateway (DRG), which is a virtual router that provides a path for private network traffic between your VCN and your existing network. You use it with other Networking Service components to create an IPSec VPN or a connection that uses Oracle Cloud Infrastructure FastConnect. For more information, see @@ -19,6 +19,9 @@ class Drg(object): talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ diff --git a/src/oci/core/models/drg_attachment.py b/src/oci/core/models/drg_attachment.py index 4b9db9d523..c9c7263c49 100644 --- a/src/oci/core/models/drg_attachment.py +++ b/src/oci/core/models/drg_attachment.py @@ -12,6 +12,9 @@ class DrgAttachment(object): A link between a DRG and VCN. For more information, see `Overview of the Networking Service`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm """ diff --git a/src/oci/core/models/image.py b/src/oci/core/models/image.py index 8214c7f101..3bae9cd0a6 100644 --- a/src/oci/core/models/image.py +++ b/src/oci/core/models/image.py @@ -16,6 +16,9 @@ class Image(object): talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Concepts/computeoverview.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ diff --git a/src/oci/core/models/instance.py b/src/oci/core/models/instance.py index 24e3b05f52..26ad7dd597 100644 --- a/src/oci/core/models/instance.py +++ b/src/oci/core/models/instance.py @@ -18,6 +18,9 @@ class Instance(object): talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Concepts/computeoverview.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ @@ -213,7 +216,7 @@ def __init__(self, **kwargs): def availability_domain(self): """ **[Required]** Gets the availability_domain of this Instance. - The Availability Domain the instance is running in. + The availability domain the instance is running in. Example: `Uocm:PHX-AD-1` @@ -227,7 +230,7 @@ def availability_domain(self): def availability_domain(self, availability_domain): """ Sets the availability_domain of this Instance. - The Availability Domain the instance is running in. + The availability domain the instance is running in. Example: `Uocm:PHX-AD-1` @@ -329,7 +332,7 @@ def display_name(self, display_name): def extended_metadata(self): """ Gets the extended_metadata of this Instance. - Additional metadata key/value pairs that you provide. They serve a similar purpose and functionality from fields in the 'metadata' object. + Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the 'metadata' object. They are distinguished from 'metadata' fields in that these can be nested JSON objects (whereas 'metadata' fields are string/string maps only). @@ -343,7 +346,7 @@ def extended_metadata(self): def extended_metadata(self, extended_metadata): """ Sets the extended_metadata of this Instance. - Additional metadata key/value pairs that you provide. They serve a similar purpose and functionality from fields in the 'metadata' object. + Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the 'metadata' object. They are distinguished from 'metadata' fields in that these can be nested JSON objects (whereas 'metadata' fields are string/string maps only). @@ -357,11 +360,16 @@ def extended_metadata(self, extended_metadata): def fault_domain(self): """ Gets the fault_domain of this Instance. - The name of the Fault Domain the instance is running in. + The name of the fault domain the instance is running in. + + A fault domain is a grouping of hardware and infrastructure within an availability domain. + Each availability domain contains three fault domains. Fault domains let you distribute your + instances so that they are not on the same physical hardware within a single availability domain. + A hardware failure or Compute hardware maintenance that affects one fault domain does not affect + instances in other fault domains. - A Fault Domain is a logical grouping of hardware and infrastructure within an Availability Domain that can become - unavailable in its entirety either due to hardware failure such as Top-of-rack (TOR) switch failure or due to - planned software maintenance such as security updates that reboot your instances. + If you do not specify the fault domain, the system selects one for you. To change the fault + domain for an instance, terminate it and launch a new instance in the preferred fault domain. Example: `FAULT-DOMAIN-1` @@ -375,11 +383,16 @@ def fault_domain(self): def fault_domain(self, fault_domain): """ Sets the fault_domain of this Instance. - The name of the Fault Domain the instance is running in. + The name of the fault domain the instance is running in. + + A fault domain is a grouping of hardware and infrastructure within an availability domain. + Each availability domain contains three fault domains. Fault domains let you distribute your + instances so that they are not on the same physical hardware within a single availability domain. + A hardware failure or Compute hardware maintenance that affects one fault domain does not affect + instances in other fault domains. - A Fault Domain is a logical grouping of hardware and infrastructure within an Availability Domain that can become - unavailable in its entirety either due to hardware failure such as Top-of-rack (TOR) switch failure or due to - planned software maintenance such as security updates that reboot your instances. + If you do not specify the fault domain, the system selects one for you. To change the fault + domain for an instance, terminate it and launch a new instance in the preferred fault domain. Example: `FAULT-DOMAIN-1` @@ -657,7 +670,7 @@ def metadata(self, metadata): def region(self): """ **[Required]** Gets the region of this Instance. - The region that contains the Availability Domain the instance is running in. + The region that contains the availability domain the instance is running in. Example: `phx` @@ -671,7 +684,7 @@ def region(self): def region(self, region): """ Sets the region of this Instance. - The region that contains the Availability Domain the instance is running in. + The region that contains the availability domain the instance is running in. Example: `phx` diff --git a/src/oci/core/models/internet_gateway.py b/src/oci/core/models/internet_gateway.py index 44f5b70648..b796f47d04 100644 --- a/src/oci/core/models/internet_gateway.py +++ b/src/oci/core/models/internet_gateway.py @@ -10,13 +10,16 @@ class InternetGateway(object): """ Represents a router that connects the edge of a VCN with the Internet. For an example scenario - that uses an Internet Gateway, see + that uses an internet gateway, see `Typical Networking Service Scenarios`__. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm#scenarios __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ @@ -119,7 +122,7 @@ def __init__(self, **kwargs): def compartment_id(self): """ **[Required]** Gets the compartment_id of this InternetGateway. - The OCID of the compartment containing the Internet Gateway. + The OCID of the compartment containing the internet gateway. :return: The compartment_id of this InternetGateway. @@ -131,7 +134,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this InternetGateway. - The OCID of the compartment containing the Internet Gateway. + The OCID of the compartment containing the internet gateway. :param compartment_id: The compartment_id of this InternetGateway. @@ -239,7 +242,7 @@ def freeform_tags(self, freeform_tags): def id(self): """ **[Required]** Gets the id of this InternetGateway. - The Internet Gateway's Oracle ID (OCID). + The internet gateway's Oracle ID (OCID). :return: The id of this InternetGateway. @@ -251,7 +254,7 @@ def id(self): def id(self, id): """ Sets the id of this InternetGateway. - The Internet Gateway's Oracle ID (OCID). + The internet gateway's Oracle ID (OCID). :param id: The id of this InternetGateway. @@ -289,7 +292,7 @@ def is_enabled(self, is_enabled): def lifecycle_state(self): """ **[Required]** Gets the lifecycle_state of this InternetGateway. - The Internet Gateway's current state. + The internet gateway's current state. Allowed values for this property are: "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -304,7 +307,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this InternetGateway. - The Internet Gateway's current state. + The internet gateway's current state. :param lifecycle_state: The lifecycle_state of this InternetGateway. @@ -319,7 +322,7 @@ def lifecycle_state(self, lifecycle_state): def time_created(self): """ Gets the time_created of this InternetGateway. - The date and time the Internet Gateway was created, in the format defined by RFC3339. + The date and time the internet gateway was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` @@ -333,7 +336,7 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this InternetGateway. - The date and time the Internet Gateway was created, in the format defined by RFC3339. + The date and time the internet gateway was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` @@ -347,7 +350,7 @@ def time_created(self, time_created): def vcn_id(self): """ **[Required]** Gets the vcn_id of this InternetGateway. - The OCID of the VCN the Internet Gateway belongs to. + The OCID of the VCN the internet gateway belongs to. :return: The vcn_id of this InternetGateway. @@ -359,7 +362,7 @@ def vcn_id(self): def vcn_id(self, vcn_id): """ Sets the vcn_id of this InternetGateway. - The OCID of the VCN the Internet Gateway belongs to. + The OCID of the VCN the internet gateway belongs to. :param vcn_id: The vcn_id of this InternetGateway. diff --git a/src/oci/core/models/ip_sec_connection.py b/src/oci/core/models/ip_sec_connection.py index 35ac75bf44..b2ad63cfab 100644 --- a/src/oci/core/models/ip_sec_connection.py +++ b/src/oci/core/models/ip_sec_connection.py @@ -18,6 +18,9 @@ class IPSecConnection(object): talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ diff --git a/src/oci/core/models/launch_instance_details.py b/src/oci/core/models/launch_instance_details.py index 7b0a6ac6c2..b5dfa2b62a 100644 --- a/src/oci/core/models/launch_instance_details.py +++ b/src/oci/core/models/launch_instance_details.py @@ -135,7 +135,7 @@ def __init__(self, **kwargs): def availability_domain(self): """ **[Required]** Gets the availability_domain of this LaunchInstanceDetails. - The Availability Domain of the instance. + The availability domain of the instance. Example: `Uocm:PHX-AD-1` @@ -149,7 +149,7 @@ def availability_domain(self): def availability_domain(self, availability_domain): """ Sets the availability_domain of this LaunchInstanceDetails. - The Availability Domain of the instance. + The availability domain of the instance. Example: `Uocm:PHX-AD-1` @@ -277,7 +277,7 @@ def display_name(self, display_name): def extended_metadata(self): """ Gets the extended_metadata of this LaunchInstanceDetails. - Additional metadata key/value pairs that you provide. They serve a similar purpose and functionality from fields in the 'metadata' object. + Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the 'metadata' object. They are distinguished from 'metadata' fields in that these can be nested JSON objects (whereas 'metadata' fields are string/string maps only). @@ -291,7 +291,7 @@ def extended_metadata(self): def extended_metadata(self, extended_metadata): """ Sets the extended_metadata of this LaunchInstanceDetails. - Additional metadata key/value pairs that you provide. They serve a similar purpose and functionality from fields in the 'metadata' object. + Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the 'metadata' object. They are distinguished from 'metadata' fields in that these can be nested JSON objects (whereas 'metadata' fields are string/string maps only). @@ -305,10 +305,14 @@ def extended_metadata(self, extended_metadata): def fault_domain(self): """ Gets the fault_domain of this LaunchInstanceDetails. - The name of the Fault Domain in which to launch an instance. + A fault domain is a grouping of hardware and infrastructure within an availability domain. + Each availability domain contains three fault domains. Fault domains let you distribute your + instances so that they are not on the same physical hardware within a single availability domain. + A hardware failure or Compute hardware maintenance that affects one fault domain does not affect + instances in other fault domains. - To get a list of Fault Domains, use the :func:`list_fault_domains` - operation in the Identity and Access Management Service API. + If you do not specify the fault domain, the system selects one for you. To change the fault + domain for an instance, terminate it and launch a new instance in the preferred fault domain. Example: `FAULT-DOMAIN-1` @@ -322,10 +326,14 @@ def fault_domain(self): def fault_domain(self, fault_domain): """ Sets the fault_domain of this LaunchInstanceDetails. - The name of the Fault Domain in which to launch an instance. - - To get a list of Fault Domains, use the :func:`list_fault_domains` - operation in the Identity and Access Management Service API. + A fault domain is a grouping of hardware and infrastructure within an availability domain. + Each availability domain contains three fault domains. Fault domains let you distribute your + instances so that they are not on the same physical hardware within a single availability domain. + A hardware failure or Compute hardware maintenance that affects one fault domain does not affect + instances in other fault domains. + + If you do not specify the fault domain, the system selects one for you. To change the fault + domain for an instance, terminate it and launch a new instance in the preferred fault domain. Example: `FAULT-DOMAIN-1` diff --git a/src/oci/core/models/local_peering_gateway.py b/src/oci/core/models/local_peering_gateway.py index d396ccff26..e0ed1a0e5d 100644 --- a/src/oci/core/models/local_peering_gateway.py +++ b/src/oci/core/models/local_peering_gateway.py @@ -19,6 +19,9 @@ class LocalPeeringGateway(object): talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/VCNpeering.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ diff --git a/src/oci/core/models/private_ip.py b/src/oci/core/models/private_ip.py index da31a2d41c..da191ebc7c 100644 --- a/src/oci/core/models/private_ip.py +++ b/src/oci/core/models/private_ip.py @@ -37,6 +37,9 @@ class PrivateIp(object): talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingIPaddresses.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ @@ -142,7 +145,7 @@ def __init__(self, **kwargs): def availability_domain(self): """ Gets the availability_domain of this PrivateIp. - The private IP's Availability Domain. + The private IP's availability domain. Example: `Uocm:PHX-AD-1` @@ -156,7 +159,7 @@ def availability_domain(self): def availability_domain(self, availability_domain): """ Sets the availability_domain of this PrivateIp. - The private IP's Availability Domain. + The private IP's availability domain. Example: `Uocm:PHX-AD-1` diff --git a/src/oci/core/models/public_ip.py b/src/oci/core/models/public_ip.py index ccd2636e51..da862a8496 100644 --- a/src/oci/core/models/public_ip.py +++ b/src/oci/core/models/public_ip.py @@ -19,6 +19,9 @@ class PublicIp(object): For more information and comparison of the two types, see `Public IP Addresses`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingpublicIPs.htm """ @@ -177,9 +180,9 @@ def __init__(self, **kwargs): def availability_domain(self): """ Gets the availability_domain of this PublicIp. - The public IP's Availability Domain. This property is set only for ephemeral public IPs + The public IP's availability domain. This property is set only for ephemeral public IPs (that is, when the `scope` of the public IP is set to AVAILABILITY_DOMAIN). The value - is the Availability Domain of the assigned private IP. + is the availability domain of the assigned private IP. Example: `Uocm:PHX-AD-1` @@ -193,9 +196,9 @@ def availability_domain(self): def availability_domain(self, availability_domain): """ Sets the availability_domain of this PublicIp. - The public IP's Availability Domain. This property is set only for ephemeral public IPs + The public IP's availability domain. This property is set only for ephemeral public IPs (that is, when the `scope` of the public IP is set to AVAILABILITY_DOMAIN). The value - is the Availability Domain of the assigned private IP. + is the availability domain of the assigned private IP. Example: `Uocm:PHX-AD-1` @@ -497,12 +500,12 @@ def private_ip_id(self, private_ip_id): def scope(self): """ Gets the scope of this PublicIp. - Whether the public IP is regional or specific to a particular Availability Domain. + Whether the public IP is regional or specific to a particular availability domain. * `REGION`: The public IP exists within a region and can be assigned to a private IP - in any Availability Domain in the region. Reserved public IPs have `scope` = `REGION`. + in any availability domain in the region. Reserved public IPs have `scope` = `REGION`. - * `AVAILABILITY_DOMAIN`: The public IP exists within the Availability Domain of the private IP + * `AVAILABILITY_DOMAIN`: The public IP exists within the availability domain of the private IP it's assigned to, which is specified by the `availabilityDomain` property of the public IP object. Ephemeral public IPs have `scope` = `AVAILABILITY_DOMAIN`. @@ -519,12 +522,12 @@ def scope(self): def scope(self, scope): """ Sets the scope of this PublicIp. - Whether the public IP is regional or specific to a particular Availability Domain. + Whether the public IP is regional or specific to a particular availability domain. * `REGION`: The public IP exists within a region and can be assigned to a private IP - in any Availability Domain in the region. Reserved public IPs have `scope` = `REGION`. + in any availability domain in the region. Reserved public IPs have `scope` = `REGION`. - * `AVAILABILITY_DOMAIN`: The public IP exists within the Availability Domain of the private IP + * `AVAILABILITY_DOMAIN`: The public IP exists within the availability domain of the private IP it's assigned to, which is specified by the `availabilityDomain` property of the public IP object. Ephemeral public IPs have `scope` = `AVAILABILITY_DOMAIN`. diff --git a/src/oci/core/models/remote_peering_connection.py b/src/oci/core/models/remote_peering_connection.py index 6345e2d343..1801e01e6c 100644 --- a/src/oci/core/models/remote_peering_connection.py +++ b/src/oci/core/models/remote_peering_connection.py @@ -19,6 +19,9 @@ class RemotePeeringConnection(object): talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/VCNpeering.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ diff --git a/src/oci/core/models/route_table.py b/src/oci/core/models/route_table.py index 5115df2af2..e4877765e6 100644 --- a/src/oci/core/models/route_table.py +++ b/src/oci/core/models/route_table.py @@ -17,6 +17,9 @@ class RouteTable(object): talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ diff --git a/src/oci/core/models/security_list.py b/src/oci/core/models/security_list.py index dd6d2bbff9..7402abba8d 100644 --- a/src/oci/core/models/security_list.py +++ b/src/oci/core/models/security_list.py @@ -23,6 +23,9 @@ class SecurityList(object): talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/securitylists.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ diff --git a/src/oci/core/models/service_gateway.py b/src/oci/core/models/service_gateway.py index 32a0bcb0d3..c9f876368e 100644 --- a/src/oci/core/models/service_gateway.py +++ b/src/oci/core/models/service_gateway.py @@ -21,6 +21,9 @@ class ServiceGateway(object): talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/servicegateway.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ diff --git a/src/oci/core/models/subnet.py b/src/oci/core/models/subnet.py index b9399a8edf..9307cf55ce 100644 --- a/src/oci/core/models/subnet.py +++ b/src/oci/core/models/subnet.py @@ -9,7 +9,7 @@ @init_model_state_from_kwargs class Subnet(object): """ - A logical subdivision of a VCN. Each subnet exists in a single Availability Domain and + A logical subdivision of a VCN. Each subnet exists in a single availability domain and consists of a contiguous range of IP addresses that do not overlap with other subnets in the VCN. Example: 172.16.1.0/24. For more information, see `Overview of the Networking Service`__ and @@ -19,6 +19,9 @@ class Subnet(object): talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVCNs.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm @@ -185,7 +188,7 @@ def __init__(self, **kwargs): def availability_domain(self): """ **[Required]** Gets the availability_domain of this Subnet. - The subnet's Availability Domain. + The subnet's availability domain. Example: `Uocm:PHX-AD-1` @@ -199,7 +202,7 @@ def availability_domain(self): def availability_domain(self, availability_domain): """ Sets the availability_domain of this Subnet. - The subnet's Availability Domain. + The subnet's availability domain. Example: `Uocm:PHX-AD-1` diff --git a/src/oci/core/models/update_instance_details.py b/src/oci/core/models/update_instance_details.py index 5c22000ce5..1f15868c4b 100644 --- a/src/oci/core/models/update_instance_details.py +++ b/src/oci/core/models/update_instance_details.py @@ -29,22 +29,36 @@ def __init__(self, **kwargs): The value to assign to the freeform_tags property of this UpdateInstanceDetails. :type freeform_tags: dict(str, str) + :param metadata: + The value to assign to the metadata property of this UpdateInstanceDetails. + :type metadata: dict(str, str) + + :param extended_metadata: + The value to assign to the extended_metadata property of this UpdateInstanceDetails. + :type extended_metadata: dict(str, object) + """ self.swagger_types = { 'defined_tags': 'dict(str, dict(str, object))', 'display_name': 'str', - 'freeform_tags': 'dict(str, str)' + 'freeform_tags': 'dict(str, str)', + 'metadata': 'dict(str, str)', + 'extended_metadata': 'dict(str, object)' } self.attribute_map = { 'defined_tags': 'definedTags', 'display_name': 'displayName', - 'freeform_tags': 'freeformTags' + 'freeform_tags': 'freeformTags', + 'metadata': 'metadata', + 'extended_metadata': 'extendedMetadata' } self._defined_tags = None self._display_name = None self._freeform_tags = None + self._metadata = None + self._extended_metadata = None @property def defined_tags(self): @@ -146,6 +160,86 @@ def freeform_tags(self, freeform_tags): """ self._freeform_tags = freeform_tags + @property + def metadata(self): + """ + Gets the metadata of this UpdateInstanceDetails. + Custom metadata key/value string pairs that you provide. Any set of key/value pairs + provided here will completely replace the current set of key/value pairs in the 'metadata' + field on the instance. + + Both the 'user_data' and 'ssh_authorized_keys' fields cannot be changed after an instance + has launched. Any request which updates, removes, or adds either of these fields will be + rejected. You must provide the same values for 'user_data' and 'ssh_authorized_keys' that + already exist on the instance. + + + :return: The metadata of this UpdateInstanceDetails. + :rtype: dict(str, str) + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this UpdateInstanceDetails. + Custom metadata key/value string pairs that you provide. Any set of key/value pairs + provided here will completely replace the current set of key/value pairs in the 'metadata' + field on the instance. + + Both the 'user_data' and 'ssh_authorized_keys' fields cannot be changed after an instance + has launched. Any request which updates, removes, or adds either of these fields will be + rejected. You must provide the same values for 'user_data' and 'ssh_authorized_keys' that + already exist on the instance. + + + :param metadata: The metadata of this UpdateInstanceDetails. + :type: dict(str, str) + """ + self._metadata = metadata + + @property + def extended_metadata(self): + """ + Gets the extended_metadata of this UpdateInstanceDetails. + Additional metadata key/value pairs that you provide. They serve the same purpose and + functionality as fields in the 'metadata' object. + + They are distinguished from 'metadata' fields in that these can be nested JSON objects + (whereas 'metadata' fields are string/string maps only). + + Both the 'user_data' and 'ssh_authorized_keys' fields cannot be changed after an instance + has launched. Any request which updates, removes, or adds either of these fields will be + rejected. You must provide the same values for 'user_data' and 'ssh_authorized_keys' that + already exist on the instance. + + + :return: The extended_metadata of this UpdateInstanceDetails. + :rtype: dict(str, object) + """ + return self._extended_metadata + + @extended_metadata.setter + def extended_metadata(self, extended_metadata): + """ + Sets the extended_metadata of this UpdateInstanceDetails. + Additional metadata key/value pairs that you provide. They serve the same purpose and + functionality as fields in the 'metadata' object. + + They are distinguished from 'metadata' fields in that these can be nested JSON objects + (whereas 'metadata' fields are string/string maps only). + + Both the 'user_data' and 'ssh_authorized_keys' fields cannot be changed after an instance + has launched. Any request which updates, removes, or adds either of these fields will be + rejected. You must provide the same values for 'user_data' and 'ssh_authorized_keys' that + already exist on the instance. + + + :param extended_metadata: The extended_metadata of this UpdateInstanceDetails. + :type: dict(str, object) + """ + self._extended_metadata = extended_metadata + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/core/models/vcn.py b/src/oci/core/models/vcn.py index 7d6bff667b..e5ca288a95 100644 --- a/src/oci/core/models/vcn.py +++ b/src/oci/core/models/vcn.py @@ -9,13 +9,16 @@ @init_model_state_from_kwargs class Vcn(object): """ - A Virtual Cloud Network (VCN). For more information, see + A virtual cloud network (VCN). For more information, see `Overview of the Networking Service`__. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ diff --git a/src/oci/core/models/virtual_circuit.py b/src/oci/core/models/virtual_circuit.py index 12cd404e8e..8da0166099 100644 --- a/src/oci/core/models/virtual_circuit.py +++ b/src/oci/core/models/virtual_circuit.py @@ -29,6 +29,9 @@ class VirtualCircuit(object): talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ diff --git a/src/oci/core/models/vnic.py b/src/oci/core/models/vnic.py index 9cff159d2f..133eee5498 100644 --- a/src/oci/core/models/vnic.py +++ b/src/oci/core/models/vnic.py @@ -25,6 +25,9 @@ class Vnic(object): talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVNICs.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingIPaddresses.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm @@ -170,7 +173,7 @@ def __init__(self, **kwargs): def availability_domain(self): """ **[Required]** Gets the availability_domain of this Vnic. - The VNIC's Availability Domain. + The VNIC's availability domain. Example: `Uocm:PHX-AD-1` @@ -184,7 +187,7 @@ def availability_domain(self): def availability_domain(self, availability_domain): """ Sets the availability_domain of this Vnic. - The VNIC's Availability Domain. + The VNIC's availability domain. Example: `Uocm:PHX-AD-1` diff --git a/src/oci/core/models/vnic_attachment.py b/src/oci/core/models/vnic_attachment.py index 10bb9b8429..c5a43d51c8 100644 --- a/src/oci/core/models/vnic_attachment.py +++ b/src/oci/core/models/vnic_attachment.py @@ -12,6 +12,9 @@ class VnicAttachment(object): Represents an attachment between a VNIC and an instance. For more information, see `Virtual Network Interface Cards (VNICs)`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVNICs.htm """ @@ -127,7 +130,7 @@ def __init__(self, **kwargs): def availability_domain(self): """ **[Required]** Gets the availability_domain of this VnicAttachment. - The Availability Domain of the instance. + The availability domain of the instance. Example: `Uocm:PHX-AD-1` @@ -141,7 +144,7 @@ def availability_domain(self): def availability_domain(self, availability_domain): """ Sets the availability_domain of this VnicAttachment. - The Availability Domain of the instance. + The availability domain of the instance. Example: `Uocm:PHX-AD-1` diff --git a/src/oci/core/models/volume.py b/src/oci/core/models/volume.py index c8c8f1968e..cf87cbc25a 100644 --- a/src/oci/core/models/volume.py +++ b/src/oci/core/models/volume.py @@ -17,6 +17,9 @@ class Volume(object): talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/overview.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ @@ -155,7 +158,7 @@ def __init__(self, **kwargs): def availability_domain(self): """ **[Required]** Gets the availability_domain of this Volume. - The Availability Domain of the volume. + The availability domain of the volume. Example: `Uocm:PHX-AD-1` @@ -169,7 +172,7 @@ def availability_domain(self): def availability_domain(self, availability_domain): """ Sets the availability_domain of this Volume. - The Availability Domain of the volume. + The availability domain of the volume. Example: `Uocm:PHX-AD-1` @@ -429,7 +432,7 @@ def size_in_mbs(self, size_in_mbs): def source_details(self): """ Gets the source_details of this Volume. - The volume source, either an existing volume in the same Availability Domain or a volume backup. + The volume source, either an existing volume in the same availability domain or a volume backup. If null, an empty volume is created. @@ -442,7 +445,7 @@ def source_details(self): def source_details(self, source_details): """ Sets the source_details of this Volume. - The volume source, either an existing volume in the same Availability Domain or a volume backup. + The volume source, either an existing volume in the same availability domain or a volume backup. If null, an empty volume is created. diff --git a/src/oci/core/models/volume_attachment.py b/src/oci/core/models/volume_attachment.py index f40199b314..fe6839ec70 100644 --- a/src/oci/core/models/volume_attachment.py +++ b/src/oci/core/models/volume_attachment.py @@ -16,6 +16,9 @@ class VolumeAttachment(object): For general information about volume attachments, see `Overview of Block Volume Storage`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/overview.htm """ @@ -169,7 +172,7 @@ def attachment_type(self, attachment_type): def availability_domain(self): """ **[Required]** Gets the availability_domain of this VolumeAttachment. - The Availability Domain of an instance. + The availability domain of an instance. Example: `Uocm:PHX-AD-1` @@ -183,7 +186,7 @@ def availability_domain(self): def availability_domain(self, availability_domain): """ Sets the availability_domain of this VolumeAttachment. - The Availability Domain of an instance. + The availability domain of an instance. Example: `Uocm:PHX-AD-1` diff --git a/src/oci/core/models/volume_backup.py b/src/oci/core/models/volume_backup.py index ea9d65e6fd..e886e4d02a 100644 --- a/src/oci/core/models/volume_backup.py +++ b/src/oci/core/models/volume_backup.py @@ -17,6 +17,9 @@ class VolumeBackup(object): talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/overview.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ diff --git a/src/oci/core/models/volume_backup_policy.py b/src/oci/core/models/volume_backup_policy.py index 668d32faa1..3578eb535f 100644 --- a/src/oci/core/models/volume_backup_policy.py +++ b/src/oci/core/models/volume_backup_policy.py @@ -9,7 +9,12 @@ @init_model_state_from_kwargs class VolumeBackupPolicy(object): """ - A policy for automatically creating volume backups according to a recurring schedule. Has a set of one or more schedules that control when and how backups are created. + A policy for automatically creating volume backups according to a + recurring schedule. Has a set of one or more schedules that control when and + how backups are created. + + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. """ def __init__(self, **kwargs): diff --git a/src/oci/core/models/volume_group.py b/src/oci/core/models/volume_group.py index bc3455a087..23f7a77960 100644 --- a/src/oci/core/models/volume_group.py +++ b/src/oci/core/models/volume_group.py @@ -9,7 +9,11 @@ @init_model_state_from_kwargs class VolumeGroup(object): """ - Specifies a volume group which is a collection of volumes. For more information, see `Volume Groups`__. + Specifies a volume group which is a collection of + volumes. For more information, see `Volume Groups`__. + + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. __ https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/volumegroups.htm """ diff --git a/src/oci/core/models/volume_group_backup.py b/src/oci/core/models/volume_group_backup.py index f2e2499db4..828ddd1f75 100644 --- a/src/oci/core/models/volume_group_backup.py +++ b/src/oci/core/models/volume_group_backup.py @@ -16,6 +16,9 @@ class VolumeGroupBackup(object): talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/volumegroups.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ diff --git a/src/oci/core/virtual_network_client.py b/src/oci/core/virtual_network_client.py index 6bc937260f..e15b55e1a5 100644 --- a/src/oci/core/virtual_network_client.py +++ b/src/oci/core/virtual_network_client.py @@ -99,7 +99,7 @@ def attach_service_id(self, service_gateway_id, attach_service_details, **kwargs __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param ServiceIdRequestDetails attach_service_details: (required) - ServiceId of Service to be attached to a Service Gateway. + ServiceId of Service to be attached to a service gateway. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` @@ -464,7 +464,7 @@ def connect_remote_peering_connections(self, remote_peering_connection_id, conne def create_cpe(self, create_cpe_details, **kwargs): """ CreateCpe - Creates a new virtual Customer-Premises Equipment (CPE) object in the specified compartment. For + Creates a new virtual customer-premises equipment (CPE) object in the specified compartment. For more information, see `IPSec VPNs`__. For the purposes of access control, you must provide the OCID of the compartment where you want @@ -813,7 +813,7 @@ def create_dhcp_options(self, create_dhcp_details, **kwargs): def create_drg(self, create_drg_details, **kwargs): """ CreateDrg - Creates a new Dynamic Routing Gateway (DRG) in the specified compartment. For more information, + Creates a new dynamic routing gateway (DRG) in the specified compartment. For more information, see `Dynamic Routing Gateways (DRGs)`__. For the purposes of access control, you must provide the OCID of the compartment where you want @@ -979,24 +979,24 @@ def create_drg_attachment(self, create_drg_attachment_details, **kwargs): def create_internet_gateway(self, create_internet_gateway_details, **kwargs): """ CreateInternetGateway - Creates a new Internet Gateway for the specified VCN. For more information, see + Creates a new internet gateway for the specified VCN. For more information, see `Access to the Internet`__. For the purposes of access control, you must provide the OCID of the compartment where you want the Internet - Gateway to reside. Notice that the Internet Gateway doesn't have to be in the same compartment as the VCN or + Gateway to reside. Notice that the internet gateway doesn't have to be in the same compartment as the VCN or other Networking Service components. If you're not sure which compartment to use, put the Internet Gateway in the same compartment with the VCN. For more information about compartments and access control, see `Overview of the IAM Service`__. For information about OCIDs, see `Resource Identifiers`__. - You may optionally specify a *display name* for the Internet Gateway, otherwise a default is provided. It + You may optionally specify a *display name* for the internet gateway, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. - For traffic to flow between a subnet and an Internet Gateway, you must create a route rule accordingly in - the subnet's route table (for example, 0.0.0.0/0 > Internet Gateway). See + For traffic to flow between a subnet and an internet gateway, you must create a route rule accordingly in + the subnet's route table (for example, 0.0.0.0/0 > internet gateway). See :func:`update_route_table`. - You must specify whether the Internet Gateway is enabled when you create it. If it's disabled, that means no + You must specify whether the internet gateway is enabled when you create it. If it's disabled, that means no traffic will flow to/from the internet even if there's a route rule that enables that traffic. You can later use :func:`update_internet_gateway` to easily disable/enable the gateway without changing the route rule. @@ -1007,7 +1007,7 @@ def create_internet_gateway(self, create_internet_gateway_details, **kwargs): :param CreateInternetGatewayDetails create_internet_gateway_details: (required) - Details for creating a new Internet Gateway. + Details for creating a new internet gateway. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -1319,7 +1319,7 @@ def create_public_ip(self, create_public_ip_details, **kwargs): * **For an ephemeral public IP:** You must also specify a `privateIpId` with the OCID of the primary private IP you want to assign the public IP to. The public IP is created in - the same Availability Domain as the private IP. An ephemeral public IP must always be + the same availability domain as the private IP. An ephemeral public IP must always be assigned to a private IP, and only to the *primary* private IP on a VNIC, not a secondary private IP. @@ -1835,7 +1835,7 @@ def create_subnet(self, create_subnet_details, **kwargs): def create_vcn(self, create_vcn_details, **kwargs): """ CreateVcn - Creates a new Virtual Cloud Network (VCN). For more information, see + Creates a new virtual cloud network (VCN). For more information, see `VCNs and Subnets`__. For the VCN you must specify a single, contiguous IPv4 CIDR block. Oracle recommends using one of the @@ -1861,7 +1861,7 @@ def create_vcn(self, create_vcn_details, **kwargs): The OCID for each is returned in the response. You can't delete these default objects, but you can change their contents (that is, change the route rules, security list rules, and so on). - The VCN and subnets you create are not accessible until you attach an Internet Gateway or set up an IPSec VPN + The VCN and subnets you create are not accessible until you attach an internet gateway or set up an IPSec VPN or FastConnect. For more information, see `Overview of the Networking Service`__. @@ -2485,7 +2485,7 @@ def delete_drg_attachment(self, drg_attachment_id, **kwargs): def delete_internet_gateway(self, ig_id, **kwargs): """ DeleteInternetGateway - Deletes the specified Internet Gateway. The Internet Gateway does not have to be disabled, but + Deletes the specified internet gateway. The internet gateway does not have to be disabled, but there must not be a route table that lists it as a target. This is an asynchronous operation. The gateway's `lifecycleState` will change to TERMINATING temporarily @@ -2493,7 +2493,7 @@ def delete_internet_gateway(self, ig_id, **kwargs): :param str ig_id: (required) - The OCID of the Internet Gateway. + The OCID of the internet gateway. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` @@ -3440,7 +3440,7 @@ def detach_service_id(self, service_gateway_id, detach_service_details, **kwargs __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param ServiceIdRequestDetails detach_service_details: (required) - ServiceId of Service to be detached from a Service Gateway. + ServiceId of Service to be detached from a service gateway. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` @@ -4092,11 +4092,11 @@ def get_fast_connect_provider_service(self, provider_service_id, **kwargs): def get_internet_gateway(self, ig_id, **kwargs): """ GetInternetGateway - Gets the specified Internet Gateway's information. + Gets the specified internet gateway's information. :param str ig_id: (required) - The OCID of the Internet Gateway. + The OCID of the internet gateway. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -5313,7 +5313,7 @@ def list_allowed_peer_regions_for_remote_peering(self, **kwargs): def list_cpes(self, compartment_id, **kwargs): """ ListCpes - Lists the Customer-Premises Equipment objects (CPEs) in the specified compartment. + Lists the customer-premises equipment objects (CPEs) in the specified compartment. :param str compartment_id: (required) @@ -5410,9 +5410,9 @@ def list_cross_connect_groups(self, compartment_id, **kwargs): sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you - optionally filter by Availability Domain if the scope of the resource type is within a - single Availability Domain. If you call one of these \"List\" operations without specifying - an Availability Domain, the resources are grouped by Availability Domain, then sorted. + optionally filter by availability domain if the scope of the resource type is within a + single availability domain. If you call one of these \"List\" operations without specifying + an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: "TIMECREATED", "DISPLAYNAME" @@ -5618,9 +5618,9 @@ def list_cross_connects(self, compartment_id, **kwargs): sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you - optionally filter by Availability Domain if the scope of the resource type is within a - single Availability Domain. If you call one of these \"List\" operations without specifying - an Availability Domain, the resources are grouped by Availability Domain, then sorted. + optionally filter by availability domain if the scope of the resource type is within a + single availability domain. If you call one of these \"List\" operations without specifying + an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: "TIMECREATED", "DISPLAYNAME" @@ -5830,9 +5830,9 @@ def list_dhcp_options(self, compartment_id, vcn_id, **kwargs): sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you - optionally filter by Availability Domain if the scope of the resource type is within a - single Availability Domain. If you call one of these \"List\" operations without specifying - an Availability Domain, the resources are grouped by Availability Domain, then sorted. + optionally filter by availability domain if the scope of the resource type is within a + single availability domain. If you call one of these \"List\" operations without specifying + an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: "TIMECREATED", "DISPLAYNAME" @@ -6268,7 +6268,7 @@ def list_fast_connect_provider_virtual_circuit_bandwidth_shapes(self, provider_s def list_internet_gateways(self, compartment_id, vcn_id, **kwargs): """ ListInternetGateways - Lists the Internet Gateways in the specified VCN and the specified compartment. + Lists the internet gateways in the specified VCN and the specified compartment. :param str compartment_id: (required) @@ -6294,9 +6294,9 @@ def list_internet_gateways(self, compartment_id, vcn_id, **kwargs): sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you - optionally filter by Availability Domain if the scope of the resource type is within a - single Availability Domain. If you call one of these \"List\" operations without specifying - an Availability Domain, the resources are grouped by Availability Domain, then sorted. + optionally filter by availability domain if the scope of the resource type is within a + single availability domain. If you call one of these \"List\" operations without specifying + an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: "TIMECREATED", "DISPLAYNAME" @@ -6671,17 +6671,17 @@ def list_public_ips(self, scope, compartment_id, **kwargs): `availabilityDomain` parameter empty. To list your ephemeral public IPs, set `scope` = `AVAILABILITY_DOMAIN`, and set the - `availabilityDomain` parameter to the desired Availability Domain. An ephemeral public IP - is always in the same Availability Domain and compartment as the private IP it's assigned to. + `availabilityDomain` parameter to the desired availability domain. An ephemeral public IP + is always in the same availability domain and compartment as the private IP it's assigned to. :param str scope: (required) - Whether the public IP is regional or specific to a particular Availability Domain. + Whether the public IP is regional or specific to a particular availability domain. * `REGION`: The public IP exists within a region and can be assigned to a private IP - in any Availability Domain in the region. Reserved public IPs have `scope` = `REGION`. + in any availability domain in the region. Reserved public IPs have `scope` = `REGION`. - * `AVAILABILITY_DOMAIN`: The public IP exists within the Availability Domain of the private IP + * `AVAILABILITY_DOMAIN`: The public IP exists within the availability domain of the private IP it's assigned to, which is specified by the `availabilityDomain` property of the public IP object. Ephemeral public IPs have `scope` = `AVAILABILITY_DOMAIN`. @@ -6699,7 +6699,7 @@ def list_public_ips(self, scope, compartment_id, **kwargs): The value of the `opc-next-page` response header from the previous \"List\" call. :param str availability_domain: (optional) - The name of the Availability Domain. + The name of the availability domain. Example: `Uocm:PHX-AD-1` @@ -6880,9 +6880,9 @@ def list_route_tables(self, compartment_id, vcn_id, **kwargs): sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you - optionally filter by Availability Domain if the scope of the resource type is within a - single Availability Domain. If you call one of these \"List\" operations without specifying - an Availability Domain, the resources are grouped by Availability Domain, then sorted. + optionally filter by availability domain if the scope of the resource type is within a + single availability domain. If you call one of these \"List\" operations without specifying + an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: "TIMECREATED", "DISPLAYNAME" @@ -7013,9 +7013,9 @@ def list_security_lists(self, compartment_id, vcn_id, **kwargs): sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you - optionally filter by Availability Domain if the scope of the resource type is within a - single Availability Domain. If you call one of these \"List\" operations without specifying - an Availability Domain, the resources are grouped by Availability Domain, then sorted. + optionally filter by availability domain if the scope of the resource type is within a + single availability domain. If you call one of these \"List\" operations without specifying + an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: "TIMECREATED", "DISPLAYNAME" @@ -7144,9 +7144,9 @@ def list_service_gateways(self, compartment_id, **kwargs): sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you - optionally filter by Availability Domain if the scope of the resource type is within a - single Availability Domain. If you call one of these \"List\" operations without specifying - an Availability Domain, the resources are grouped by Availability Domain, then sorted. + optionally filter by availability domain if the scope of the resource type is within a + single availability domain. If you call one of these \"List\" operations without specifying + an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: "TIMECREATED", "DISPLAYNAME" @@ -7346,9 +7346,9 @@ def list_subnets(self, compartment_id, vcn_id, **kwargs): sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you - optionally filter by Availability Domain if the scope of the resource type is within a - single Availability Domain. If you call one of these \"List\" operations without specifying - an Availability Domain, the resources are grouped by Availability Domain, then sorted. + optionally filter by availability domain if the scope of the resource type is within a + single availability domain. If you call one of these \"List\" operations without specifying + an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: "TIMECREATED", "DISPLAYNAME" @@ -7453,7 +7453,7 @@ def list_subnets(self, compartment_id, vcn_id, **kwargs): def list_vcns(self, compartment_id, **kwargs): """ ListVcns - Lists the Virtual Cloud Networks (VCNs) in the specified compartment. + Lists the virtual cloud networks (VCNs) in the specified compartment. :param str compartment_id: (required) @@ -7476,9 +7476,9 @@ def list_vcns(self, compartment_id, **kwargs): sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you - optionally filter by Availability Domain if the scope of the resource type is within a - single Availability Domain. If you call one of these \"List\" operations without specifying - an Availability Domain, the resources are grouped by Availability Domain, then sorted. + optionally filter by availability domain if the scope of the resource type is within a + single availability domain. If you call one of these \"List\" operations without specifying + an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: "TIMECREATED", "DISPLAYNAME" @@ -7768,9 +7768,9 @@ def list_virtual_circuits(self, compartment_id, **kwargs): sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you - optionally filter by Availability Domain if the scope of the resource type is within a - single Availability Domain. If you call one of these \"List\" operations without specifying - an Availability Domain, the resources are grouped by Availability Domain, then sorted. + optionally filter by availability domain if the scope of the resource type is within a + single availability domain. If you call one of these \"List\" operations without specifying + an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: "TIMECREATED", "DISPLAYNAME" @@ -8360,7 +8360,7 @@ def update_drg_attachment(self, drg_attachment_id, update_drg_attachment_details def update_internet_gateway(self, ig_id, update_internet_gateway_details, **kwargs): """ UpdateInternetGateway - Updates the specified Internet Gateway. You can disable/enable it, or change its display name + Updates the specified internet gateway. You can disable/enable it, or change its display name or tags. Avoid entering confidential information. If the gateway is disabled, that means no traffic will flow to/from the internet even if there's @@ -8368,10 +8368,10 @@ def update_internet_gateway(self, ig_id, update_internet_gateway_details, **kwar :param str ig_id: (required) - The OCID of the Internet Gateway. + The OCID of the internet gateway. :param UpdateInternetGatewayDetails update_internet_gateway_details: (required) - Details for updating the Internet Gateway. + Details for updating the internet gateway. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` diff --git a/src/oci/core/virtual_network_client_composite_operations.py b/src/oci/core/virtual_network_client_composite_operations.py index 08bee77618..ec02cc1040 100644 --- a/src/oci/core/virtual_network_client_composite_operations.py +++ b/src/oci/core/virtual_network_client_composite_operations.py @@ -217,7 +217,7 @@ def create_internet_gateway_and_wait_for_state(self, create_internet_gateway_det to enter the given state(s). :param CreateInternetGatewayDetails create_internet_gateway_details: (required) - Details for creating a new Internet Gateway. + Details for creating a new internet gateway. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.core.models.InternetGateway.lifecycle_state` @@ -830,7 +830,7 @@ def delete_internet_gateway_and_wait_for_state(self, ig_id, wait_for_states=[], to enter the given state(s). :param str ig_id: (required) - The OCID of the Internet Gateway. + The OCID of the internet gateway. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.core.models.InternetGateway.lifecycle_state` @@ -1466,10 +1466,10 @@ def update_internet_gateway_and_wait_for_state(self, ig_id, update_internet_gate to enter the given state(s). :param str ig_id: (required) - The OCID of the Internet Gateway. + The OCID of the internet gateway. :param UpdateInternetGatewayDetails update_internet_gateway_details: (required) - Details for updating the Internet Gateway. + Details for updating the internet gateway. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.core.models.InternetGateway.lifecycle_state` diff --git a/src/oci/database/database_client.py b/src/oci/database/database_client.py index 704d3c9a23..7a72d2cebc 100644 --- a/src/oci/database/database_client.py +++ b/src/oci/database/database_client.py @@ -522,11 +522,11 @@ def create_data_guard_association(self, database_id, create_data_guard_associati def create_db_home(self, create_db_home_with_db_system_id_details, **kwargs): """ CreateDbHome - Creates a new DB Home in the specified DB System based on the request parameters you provide. + Creates a new database home in the specified DB system based on the request parameters you provide. :param CreateDbHomeWithDbSystemIdBase create_db_home_with_db_system_id_details: (required) - Request to create a new DB Home. + Request to create a new database home. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -603,7 +603,7 @@ def db_node_action(self, db_node_id, action, **kwargs): Note that the **stop** state has no effect on the resources you consume. Billing continues for DB Nodes that you stop, and related resources continue - to apply against any relevant quotas. You must terminate the DB System + to apply against any relevant quotas. You must terminate the DB system (:func:`terminate_db_system`) to remove its resources from billing and quotas. @@ -859,7 +859,9 @@ def delete_backup(self, backup_id, **kwargs): :param str backup_id: (required) - The backup OCID. + The backup `OCID`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` @@ -928,7 +930,7 @@ def delete_backup(self, backup_id, **kwargs): def delete_db_home(self, db_home_id, **kwargs): """ DeleteDbHome - Deletes a DB Home. The DB Home and its database data are local to the DB System and will be lost when it is deleted. Oracle recommends that you back up any data in the DB System prior to deleting it. + Deletes a DB Home. The DB Home and its database data are local to the DB system and will be lost when it is deleted. Oracle recommends that you back up any data in the DB system prior to deleting it. :param str db_home_id: (required) @@ -1374,7 +1376,9 @@ def get_backup(self, backup_id, **kwargs): :param str backup_id: (required) - The backup OCID. + The backup `OCID`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -1647,7 +1651,9 @@ def get_db_home_patch(self, db_home_id, patch_id, **kwargs): __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param str patch_id: (required) - The OCID of the patch. + The `OCID`__ of the patch. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -1717,7 +1723,9 @@ def get_db_home_patch_history_entry(self, db_home_id, patch_history_entry_id, ** __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param str patch_history_entry_id: (required) - The OCID of the patch history entry. + The `OCID`__ of the patch history entry. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -1844,11 +1852,11 @@ def get_db_node(self, db_node_id, **kwargs): def get_db_system(self, db_system_id, **kwargs): """ GetDbSystem - Gets information about the specified DB System. + Gets information about the specified DB system. :param str db_system_id: (required) - The DB System `OCID`__. + The DB system `OCID`__. __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm @@ -1914,12 +1922,14 @@ def get_db_system_patch(self, db_system_id, patch_id, **kwargs): :param str db_system_id: (required) - The DB System `OCID`__. + The DB system `OCID`__. __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param str patch_id: (required) - The OCID of the patch. + The `OCID`__ of the patch. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -1984,12 +1994,14 @@ def get_db_system_patch_history_entry(self, db_system_id, patch_history_entry_id :param str db_system_id: (required) - The DB System `OCID`__. + The DB system `OCID`__. __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param str patch_history_entry_id: (required) - The OCID of the patch history entry. + The `OCID`__ of the patch history entry. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -2050,23 +2062,18 @@ def get_db_system_patch_history_entry(self, db_system_id, patch_history_entry_id def launch_db_system(self, launch_db_system_details, **kwargs): """ LaunchDbSystem - Launches a new DB System in the specified compartment and Availability Domain. You'll specify a single Oracle - Database Edition that applies to all the databases on that DB System. The selected edition cannot be changed. + Launches a new DB system in the specified compartment and availability domain. The Oracle + Database edition that you specify applies to all the databases on that DB system. The selected edition cannot be changed. - An initial database is created on the DB System based on the request parameters you provide and some default + An initial database is created on the DB system based on the request parameters you provide and some default options. For more information, see `Default Options for the Initial Database`__. - The DB System will include a command line interface (CLI) that you can use to create additional databases and - manage existing databases. For more information, see the - `Oracle Database CLI Reference`__. - - __ https://docs.us-phoenix-1.oraclecloud.com/Content/Database/Tasks/launchingDB.htm#Default_Options_for_the_Initial_Database - __ https://docs.us-phoenix-1.oraclecloud.com/Content/Database/References/odacli.htm#Oracle_Database_CLI_Reference + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Database/Tasks/launchingDB.htm#DefaultOptionsfortheInitialDatabase :param LaunchDbSystemBase launch_db_system_details: (required) - Request to launch a DB System. + Request to launch a DB system. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -2140,10 +2147,12 @@ def list_autonomous_data_warehouse_backups(self, **kwargs): __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param str compartment_id: (optional) - The compartment OCID. + The compartment `OCID`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param int limit: (optional) - The maximum number of items to return. + The maximum number of items to return per page. :param str page: (optional) The pagination token to continue listing from. @@ -2269,7 +2278,7 @@ def list_autonomous_data_warehouses(self, compartment_id, **kwargs): __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param int limit: (optional) - The maximum number of items to return. + The maximum number of items to return per page. :param str page: (optional) The pagination token to continue listing from. @@ -2392,10 +2401,12 @@ def list_autonomous_database_backups(self, **kwargs): __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param str compartment_id: (optional) - The compartment OCID. + The compartment `OCID`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param int limit: (optional) - The maximum number of items to return. + The maximum number of items to return per page. :param str page: (optional) The pagination token to continue listing from. @@ -2521,7 +2532,7 @@ def list_autonomous_databases(self, compartment_id, **kwargs): __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param int limit: (optional) - The maximum number of items to return. + The maximum number of items to return per page. :param str page: (optional) The pagination token to continue listing from. @@ -2639,13 +2650,17 @@ def list_backups(self, **kwargs): :param str database_id: (optional) - The OCID of the database. + The `OCID`__ of the database. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param str compartment_id: (optional) - The compartment OCID. + The compartment `OCID`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param int limit: (optional) - The maximum number of items to return. + The maximum number of items to return per page. :param str page: (optional) The pagination token to continue listing from. @@ -2722,7 +2737,7 @@ def list_data_guard_associations(self, database_id, **kwargs): __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param int limit: (optional) - The maximum number of items to return. + The maximum number of items to return per page. :param str page: (optional) The pagination token to continue listing from. @@ -2812,7 +2827,7 @@ def list_databases(self, compartment_id, db_home_id, **kwargs): __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param int limit: (optional) - The maximum number of items to return. + The maximum number of items to return per page. :param str page: (optional) The pagination token to continue listing from. @@ -2887,7 +2902,7 @@ def list_db_home_patch_history_entries(self, db_home_id, **kwargs): __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param int limit: (optional) - The maximum number of items to return. + The maximum number of items to return per page. :param str page: (optional) The pagination token to continue listing from. @@ -2972,7 +2987,7 @@ def list_db_home_patches(self, db_home_id, **kwargs): __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param int limit: (optional) - The maximum number of items to return. + The maximum number of items to return per page. :param str page: (optional) The pagination token to continue listing from. @@ -3048,7 +3063,7 @@ def list_db_home_patches(self, db_home_id, **kwargs): def list_db_homes(self, compartment_id, db_system_id, **kwargs): """ ListDbHomes - Gets a list of database homes in the specified DB System and compartment. A database home is a directory where Oracle database software is installed. + Gets a list of database homes in the specified DB system and compartment. A database home is a directory where Oracle database software is installed. :param str compartment_id: (required) @@ -3057,12 +3072,12 @@ def list_db_homes(self, compartment_id, db_system_id, **kwargs): __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param str db_system_id: (required) - The `OCID`__ of the DB System. + The `OCID`__ of the DB system. __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param int limit: (optional) - The maximum number of items to return. + The maximum number of items to return per page. :param str page: (optional) The pagination token to continue listing from. @@ -3128,7 +3143,7 @@ def list_db_homes(self, compartment_id, db_system_id, **kwargs): def list_db_nodes(self, compartment_id, db_system_id, **kwargs): """ ListDbNodes - Gets a list of database nodes in the specified DB System and compartment. A database node is a server running database software. + Gets a list of database nodes in the specified DB system and compartment. A database node is a server running database software. :param str compartment_id: (required) @@ -3137,12 +3152,12 @@ def list_db_nodes(self, compartment_id, db_system_id, **kwargs): __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param str db_system_id: (required) - The `OCID`__ of the DB System. + The `OCID`__ of the DB system. __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param int limit: (optional) - The maximum number of items to return. + The maximum number of items to return per page. :param str page: (optional) The pagination token to continue listing from. @@ -3208,16 +3223,16 @@ def list_db_nodes(self, compartment_id, db_system_id, **kwargs): def list_db_system_patch_history_entries(self, db_system_id, **kwargs): """ ListDbSystemPatchHistoryEntries - Gets the history of the patch actions performed on the specified DB System. + Gets the history of the patch actions performed on the specified DB system. :param str db_system_id: (required) - The DB System `OCID`__. + The DB system `OCID`__. __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param int limit: (optional) - The maximum number of items to return. + The maximum number of items to return per page. :param str page: (optional) The pagination token to continue listing from. @@ -3293,16 +3308,16 @@ def list_db_system_patch_history_entries(self, db_system_id, **kwargs): def list_db_system_patches(self, db_system_id, **kwargs): """ ListDbSystemPatches - Lists the patches applicable to the requested DB System. + Lists the patches applicable to the requested DB system. :param str db_system_id: (required) - The DB System `OCID`__. + The DB system `OCID`__. __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param int limit: (optional) - The maximum number of items to return. + The maximum number of items to return per page. :param str page: (optional) The pagination token to continue listing from. @@ -3378,7 +3393,7 @@ def list_db_system_patches(self, db_system_id, **kwargs): def list_db_system_shapes(self, availability_domain, compartment_id, **kwargs): """ ListDbSystemShapes - Gets a list of the shapes that can be used to launch a new DB System. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. + Gets a list of the shapes that can be used to launch a new DB system. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. :param str availability_domain: (required) @@ -3390,7 +3405,7 @@ def list_db_system_shapes(self, availability_domain, compartment_id, **kwargs): __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param int limit: (optional) - The maximum number of items to return. + The maximum number of items to return per page. :param str page: (optional) The pagination token to continue listing from. @@ -3456,7 +3471,7 @@ def list_db_system_shapes(self, availability_domain, compartment_id, **kwargs): def list_db_systems(self, compartment_id, **kwargs): """ ListDbSystems - Gets a list of the DB Systems in the specified compartment. You can specify a backupId to list only the DB Systems that support creating a database using this backup in this compartment. + Gets a list of the DB systems in the specified compartment. You can specify a backupId to list only the DB systems that support creating a database using this backup in this compartment. :param str compartment_id: (required) @@ -3465,13 +3480,15 @@ def list_db_systems(self, compartment_id, **kwargs): __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param int limit: (optional) - The maximum number of items to return. + The maximum number of items to return per page. :param str page: (optional) The pagination token to continue listing from. :param str backup_id: (optional) - The OCID of the backup. Specify a backupId to list only the DB Systems that support creating a database using this backup in this compartment. + The `OCID`__ of the backup. Specify a backupId to list only the DB systems that support creating a database using this backup in this compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -3544,7 +3561,7 @@ def list_db_versions(self, compartment_id, **kwargs): __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param int limit: (optional) - The maximum number of items to return. + The maximum number of items to return per page. :param str page: (optional) The pagination token to continue listing from. @@ -3553,7 +3570,9 @@ def list_db_versions(self, compartment_id, **kwargs): If provided, filters the results to the set of database versions which are supported for the given shape. :param str db_system_id: (optional) - The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system. + The DB system `OCID`__. If provided, filters the results to the set of database versions which are supported for the DB system. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -4352,11 +4371,11 @@ def switchover_data_guard_association(self, database_id, data_guard_association_ def terminate_db_system(self, db_system_id, **kwargs): """ TerminateDbSystem - Terminates a DB System and permanently deletes it and any databases running on it, and any storage volumes attached to it. The database data is local to the DB System and will be lost when the system is terminated. Oracle recommends that you back up any data in the DB System prior to terminating it. + Terminates a DB system and permanently deletes it and any databases running on it, and any storage volumes attached to it. The database data is local to the DB system and will be lost when the system is terminated. Oracle recommends that you back up any data in the DB system prior to terminating it. :param str db_system_id: (required) - The DB System `OCID`__. + The DB system `OCID`__. __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm @@ -4755,16 +4774,16 @@ def update_db_home(self, db_home_id, update_db_home_details, **kwargs): def update_db_system(self, db_system_id, update_db_system_details, **kwargs): """ UpdateDbSystem - Updates the properties of a DB System, such as the CPU core count. + Updates the properties of a DB system, such as the CPU core count. :param str db_system_id: (required) - The DB System `OCID`__. + The DB system `OCID`__. __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param UpdateDbSystemDetails update_db_system_details: (required) - Request to update the properties of a DB System. + Request to update the properties of a DB system. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` diff --git a/src/oci/database/database_client_composite_operations.py b/src/oci/database/database_client_composite_operations.py index 898924ae34..8b3a384659 100644 --- a/src/oci/database/database_client_composite_operations.py +++ b/src/oci/database/database_client_composite_operations.py @@ -260,7 +260,7 @@ def create_db_home_and_wait_for_state(self, create_db_home_with_db_system_id_det to enter the given state(s). :param CreateDbHomeWithDbSystemIdBase create_db_home_with_db_system_id_details: (required) - Request to create a new DB Home. + Request to create a new database home. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.database.models.DbHome.lifecycle_state` @@ -425,7 +425,9 @@ def delete_backup_and_wait_for_state(self, backup_id, wait_for_states=[], operat to enter the given state(s). :param str backup_id: (required) - The backup OCID. + The backup `OCID`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.database.models.Backup.lifecycle_state` @@ -505,7 +507,7 @@ def launch_db_system_and_wait_for_state(self, launch_db_system_details, wait_for to enter the given state(s). :param LaunchDbSystemBase launch_db_system_details: (required) - Request to launch a DB System. + Request to launch a DB system. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.database.models.DbSystem.lifecycle_state` @@ -543,7 +545,7 @@ def terminate_db_system_and_wait_for_state(self, db_system_id, wait_for_states=[ to enter the given state(s). :param str db_system_id: (required) - The DB System `OCID`__. + The DB system `OCID`__. __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm @@ -756,12 +758,12 @@ def update_db_system_and_wait_for_state(self, db_system_id, update_db_system_det to enter the given state(s). :param str db_system_id: (required) - The DB System `OCID`__. + The DB system `OCID`__. __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param UpdateDbSystemDetails update_db_system_details: (required) - Request to update the properties of a DB System. + Request to update the properties of a DB system. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.database.models.DbSystem.lifecycle_state` diff --git a/src/oci/database/models/autonomous_data_warehouse.py b/src/oci/database/models/autonomous_data_warehouse.py index 62dc0116f3..311e2cdc35 100644 --- a/src/oci/database/models/autonomous_data_warehouse.py +++ b/src/oci/database/models/autonomous_data_warehouse.py @@ -10,6 +10,8 @@ class AutonomousDataWarehouse(object): """ An Oracle Autonomous Data Warehouse. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. """ #: A constant which can be used with the license_model property of a AutonomousDataWarehouse. @@ -187,7 +189,9 @@ def __init__(self, **kwargs): def compartment_id(self): """ **[Required]** Gets the compartment_id of this AutonomousDataWarehouse. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this AutonomousDataWarehouse. @@ -199,7 +203,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this AutonomousDataWarehouse. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this AutonomousDataWarehouse. diff --git a/src/oci/database/models/autonomous_data_warehouse_backup.py b/src/oci/database/models/autonomous_data_warehouse_backup.py index b17c559f71..1330f3dbe4 100644 --- a/src/oci/database/models/autonomous_data_warehouse_backup.py +++ b/src/oci/database/models/autonomous_data_warehouse_backup.py @@ -12,6 +12,8 @@ class AutonomousDataWarehouseBackup(object): An Autonomous Data Warehouse backup. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ @@ -162,7 +164,9 @@ def autonomous_data_warehouse_id(self, autonomous_data_warehouse_id): def compartment_id(self): """ **[Required]** Gets the compartment_id of this AutonomousDataWarehouseBackup. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this AutonomousDataWarehouseBackup. @@ -174,7 +178,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this AutonomousDataWarehouseBackup. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this AutonomousDataWarehouseBackup. diff --git a/src/oci/database/models/autonomous_data_warehouse_backup_summary.py b/src/oci/database/models/autonomous_data_warehouse_backup_summary.py index 78bfc4bf32..a2f7be818e 100644 --- a/src/oci/database/models/autonomous_data_warehouse_backup_summary.py +++ b/src/oci/database/models/autonomous_data_warehouse_backup_summary.py @@ -12,6 +12,8 @@ class AutonomousDataWarehouseBackupSummary(object): An Autonomous Data Warehouse backup. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ @@ -162,7 +164,9 @@ def autonomous_data_warehouse_id(self, autonomous_data_warehouse_id): def compartment_id(self): """ **[Required]** Gets the compartment_id of this AutonomousDataWarehouseBackupSummary. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this AutonomousDataWarehouseBackupSummary. @@ -174,7 +178,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this AutonomousDataWarehouseBackupSummary. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this AutonomousDataWarehouseBackupSummary. diff --git a/src/oci/database/models/autonomous_data_warehouse_summary.py b/src/oci/database/models/autonomous_data_warehouse_summary.py index 9acd26131b..e1972a6f35 100644 --- a/src/oci/database/models/autonomous_data_warehouse_summary.py +++ b/src/oci/database/models/autonomous_data_warehouse_summary.py @@ -10,6 +10,8 @@ class AutonomousDataWarehouseSummary(object): """ An Oracle Autonomous Data Warehouse. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. """ #: A constant which can be used with the license_model property of a AutonomousDataWarehouseSummary. @@ -187,7 +189,9 @@ def __init__(self, **kwargs): def compartment_id(self): """ **[Required]** Gets the compartment_id of this AutonomousDataWarehouseSummary. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this AutonomousDataWarehouseSummary. @@ -199,7 +203,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this AutonomousDataWarehouseSummary. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this AutonomousDataWarehouseSummary. diff --git a/src/oci/database/models/autonomous_database.py b/src/oci/database/models/autonomous_database.py index 554a7a8aa1..76bb28aebe 100644 --- a/src/oci/database/models/autonomous_database.py +++ b/src/oci/database/models/autonomous_database.py @@ -10,6 +10,8 @@ class AutonomousDatabase(object): """ An Oracle Autonomous Database. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. """ #: A constant which can be used with the license_model property of a AutonomousDatabase. @@ -187,7 +189,9 @@ def __init__(self, **kwargs): def compartment_id(self): """ **[Required]** Gets the compartment_id of this AutonomousDatabase. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this AutonomousDatabase. @@ -199,7 +203,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this AutonomousDatabase. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this AutonomousDatabase. diff --git a/src/oci/database/models/autonomous_database_backup.py b/src/oci/database/models/autonomous_database_backup.py index a54dabe465..3711408a52 100644 --- a/src/oci/database/models/autonomous_database_backup.py +++ b/src/oci/database/models/autonomous_database_backup.py @@ -12,6 +12,8 @@ class AutonomousDatabaseBackup(object): An Autonomous Database backup. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ @@ -162,7 +164,9 @@ def autonomous_database_id(self, autonomous_database_id): def compartment_id(self): """ **[Required]** Gets the compartment_id of this AutonomousDatabaseBackup. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this AutonomousDatabaseBackup. @@ -174,7 +178,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this AutonomousDatabaseBackup. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this AutonomousDatabaseBackup. diff --git a/src/oci/database/models/autonomous_database_backup_summary.py b/src/oci/database/models/autonomous_database_backup_summary.py index 7a833b1789..3a0000d60d 100644 --- a/src/oci/database/models/autonomous_database_backup_summary.py +++ b/src/oci/database/models/autonomous_database_backup_summary.py @@ -12,6 +12,8 @@ class AutonomousDatabaseBackupSummary(object): An Autonomous Database backup. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ @@ -162,7 +164,9 @@ def autonomous_database_id(self, autonomous_database_id): def compartment_id(self): """ **[Required]** Gets the compartment_id of this AutonomousDatabaseBackupSummary. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this AutonomousDatabaseBackupSummary. @@ -174,7 +178,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this AutonomousDatabaseBackupSummary. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this AutonomousDatabaseBackupSummary. diff --git a/src/oci/database/models/autonomous_database_summary.py b/src/oci/database/models/autonomous_database_summary.py index 29676d740f..cfb6914c99 100644 --- a/src/oci/database/models/autonomous_database_summary.py +++ b/src/oci/database/models/autonomous_database_summary.py @@ -10,6 +10,8 @@ class AutonomousDatabaseSummary(object): """ An Oracle Autonomous Database. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. """ #: A constant which can be used with the license_model property of a AutonomousDatabaseSummary. @@ -187,7 +189,9 @@ def __init__(self, **kwargs): def compartment_id(self): """ **[Required]** Gets the compartment_id of this AutonomousDatabaseSummary. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this AutonomousDatabaseSummary. @@ -199,7 +203,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this AutonomousDatabaseSummary. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this AutonomousDatabaseSummary. diff --git a/src/oci/database/models/backup.py b/src/oci/database/models/backup.py index f9b13ff14e..4b620d6060 100644 --- a/src/oci/database/models/backup.py +++ b/src/oci/database/models/backup.py @@ -9,9 +9,11 @@ @init_model_state_from_kwargs class Backup(object): """ - A database backup + A database backup. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ @@ -152,7 +154,7 @@ def __init__(self, **kwargs): def availability_domain(self): """ Gets the availability_domain of this Backup. - The name of the Availability Domain that the backup is located in. + The name of the availability domain where the database backup is stored. :return: The availability_domain of this Backup. @@ -164,7 +166,7 @@ def availability_domain(self): def availability_domain(self, availability_domain): """ Sets the availability_domain of this Backup. - The name of the Availability Domain that the backup is located in. + The name of the availability domain where the database backup is stored. :param availability_domain: The availability_domain of this Backup. @@ -176,7 +178,9 @@ def availability_domain(self, availability_domain): def compartment_id(self): """ Gets the compartment_id of this Backup. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this Backup. @@ -188,7 +192,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this Backup. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this Backup. @@ -200,7 +206,7 @@ def compartment_id(self, compartment_id): def database_edition(self): """ Gets the database_edition of this Backup. - The Oracle Database Edition of the DbSystem on which the backup was taken. + The Oracle Database edition of the DB system from which the database backup was taken. :return: The database_edition of this Backup. @@ -212,7 +218,7 @@ def database_edition(self): def database_edition(self, database_edition): """ Sets the database_edition of this Backup. - The Oracle Database Edition of the DbSystem on which the backup was taken. + The Oracle Database edition of the DB system from which the database backup was taken. :param database_edition: The database_edition of this Backup. @@ -224,7 +230,9 @@ def database_edition(self, database_edition): def database_id(self): """ Gets the database_id of this Backup. - The OCID of the database. + The `OCID`__ of the database. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The database_id of this Backup. @@ -236,7 +244,9 @@ def database_id(self): def database_id(self, database_id): """ Sets the database_id of this Backup. - The OCID of the database. + The `OCID`__ of the database. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param database_id: The database_id of this Backup. @@ -248,7 +258,7 @@ def database_id(self, database_id): def db_data_size_in_mbs(self): """ Gets the db_data_size_in_mbs of this Backup. - Size of the database in mega-bytes at the time the backup was taken. + Size of the database in megabytes (MB) at the time the backup was taken. :return: The db_data_size_in_mbs of this Backup. @@ -260,7 +270,7 @@ def db_data_size_in_mbs(self): def db_data_size_in_mbs(self, db_data_size_in_mbs): """ Sets the db_data_size_in_mbs of this Backup. - Size of the database in mega-bytes at the time the backup was taken. + Size of the database in megabytes (MB) at the time the backup was taken. :param db_data_size_in_mbs: The db_data_size_in_mbs of this Backup. @@ -272,7 +282,7 @@ def db_data_size_in_mbs(self, db_data_size_in_mbs): def display_name(self): """ Gets the display_name of this Backup. - The user-friendly name for the backup. It does not have to be unique. + The user-friendly name for the backup. The name does not have to be unique. :return: The display_name of this Backup. @@ -284,7 +294,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this Backup. - The user-friendly name for the backup. It does not have to be unique. + The user-friendly name for the backup. The name does not have to be unique. :param display_name: The display_name of this Backup. @@ -296,7 +306,9 @@ def display_name(self, display_name): def id(self): """ Gets the id of this Backup. - The OCID of the backup. + The `OCID`__ of the backup. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The id of this Backup. @@ -308,7 +320,9 @@ def id(self): def id(self, id): """ Sets the id of this Backup. - The OCID of the backup. + The `OCID`__ of the backup. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param id: The id of this Backup. @@ -398,7 +412,7 @@ def time_ended(self, time_ended): def time_started(self): """ Gets the time_started of this Backup. - The date and time the backup starts. + The date and time the backup started. :return: The time_started of this Backup. @@ -410,7 +424,7 @@ def time_started(self): def time_started(self, time_started): """ Sets the time_started of this Backup. - The date and time the backup starts. + The date and time the backup started. :param time_started: The time_started of this Backup. diff --git a/src/oci/database/models/backup_summary.py b/src/oci/database/models/backup_summary.py index c36bdfcc73..cb1c7a30ab 100644 --- a/src/oci/database/models/backup_summary.py +++ b/src/oci/database/models/backup_summary.py @@ -9,9 +9,11 @@ @init_model_state_from_kwargs class BackupSummary(object): """ - A database backup + A database backup. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ @@ -152,7 +154,7 @@ def __init__(self, **kwargs): def availability_domain(self): """ Gets the availability_domain of this BackupSummary. - The name of the Availability Domain that the backup is located in. + The name of the availability domain where the database backup is stored. :return: The availability_domain of this BackupSummary. @@ -164,7 +166,7 @@ def availability_domain(self): def availability_domain(self, availability_domain): """ Sets the availability_domain of this BackupSummary. - The name of the Availability Domain that the backup is located in. + The name of the availability domain where the database backup is stored. :param availability_domain: The availability_domain of this BackupSummary. @@ -176,7 +178,9 @@ def availability_domain(self, availability_domain): def compartment_id(self): """ Gets the compartment_id of this BackupSummary. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this BackupSummary. @@ -188,7 +192,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this BackupSummary. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this BackupSummary. @@ -200,7 +206,7 @@ def compartment_id(self, compartment_id): def database_edition(self): """ Gets the database_edition of this BackupSummary. - The Oracle Database Edition of the DbSystem on which the backup was taken. + The Oracle Database edition of the DB system from which the database backup was taken. :return: The database_edition of this BackupSummary. @@ -212,7 +218,7 @@ def database_edition(self): def database_edition(self, database_edition): """ Sets the database_edition of this BackupSummary. - The Oracle Database Edition of the DbSystem on which the backup was taken. + The Oracle Database edition of the DB system from which the database backup was taken. :param database_edition: The database_edition of this BackupSummary. @@ -224,7 +230,9 @@ def database_edition(self, database_edition): def database_id(self): """ Gets the database_id of this BackupSummary. - The OCID of the database. + The `OCID`__ of the database. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The database_id of this BackupSummary. @@ -236,7 +244,9 @@ def database_id(self): def database_id(self, database_id): """ Sets the database_id of this BackupSummary. - The OCID of the database. + The `OCID`__ of the database. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param database_id: The database_id of this BackupSummary. @@ -248,7 +258,7 @@ def database_id(self, database_id): def db_data_size_in_mbs(self): """ Gets the db_data_size_in_mbs of this BackupSummary. - Size of the database in mega-bytes at the time the backup was taken. + Size of the database in megabytes (MB) at the time the backup was taken. :return: The db_data_size_in_mbs of this BackupSummary. @@ -260,7 +270,7 @@ def db_data_size_in_mbs(self): def db_data_size_in_mbs(self, db_data_size_in_mbs): """ Sets the db_data_size_in_mbs of this BackupSummary. - Size of the database in mega-bytes at the time the backup was taken. + Size of the database in megabytes (MB) at the time the backup was taken. :param db_data_size_in_mbs: The db_data_size_in_mbs of this BackupSummary. @@ -272,7 +282,7 @@ def db_data_size_in_mbs(self, db_data_size_in_mbs): def display_name(self): """ Gets the display_name of this BackupSummary. - The user-friendly name for the backup. It does not have to be unique. + The user-friendly name for the backup. The name does not have to be unique. :return: The display_name of this BackupSummary. @@ -284,7 +294,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this BackupSummary. - The user-friendly name for the backup. It does not have to be unique. + The user-friendly name for the backup. The name does not have to be unique. :param display_name: The display_name of this BackupSummary. @@ -296,7 +306,9 @@ def display_name(self, display_name): def id(self): """ Gets the id of this BackupSummary. - The OCID of the backup. + The `OCID`__ of the backup. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The id of this BackupSummary. @@ -308,7 +320,9 @@ def id(self): def id(self, id): """ Sets the id of this BackupSummary. - The OCID of the backup. + The `OCID`__ of the backup. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param id: The id of this BackupSummary. @@ -398,7 +412,7 @@ def time_ended(self, time_ended): def time_started(self): """ Gets the time_started of this BackupSummary. - The date and time the backup starts. + The date and time the backup started. :return: The time_started of this BackupSummary. @@ -410,7 +424,7 @@ def time_started(self): def time_started(self, time_started): """ Sets the time_started of this BackupSummary. - The date and time the backup starts. + The date and time the backup started. :param time_started: The time_started of this BackupSummary. diff --git a/src/oci/database/models/create_autonomous_data_warehouse_backup_details.py b/src/oci/database/models/create_autonomous_data_warehouse_backup_details.py index e8f7762a81..d0bd1643e2 100644 --- a/src/oci/database/models/create_autonomous_data_warehouse_backup_details.py +++ b/src/oci/database/models/create_autonomous_data_warehouse_backup_details.py @@ -10,6 +10,8 @@ class CreateAutonomousDataWarehouseBackupDetails(object): """ Details to create an Oracle Autonomous Data Warehouse backup. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. """ def __init__(self, **kwargs): diff --git a/src/oci/database/models/create_autonomous_data_warehouse_details.py b/src/oci/database/models/create_autonomous_data_warehouse_details.py index 5aa7e2bf57..f5679cdd23 100644 --- a/src/oci/database/models/create_autonomous_data_warehouse_details.py +++ b/src/oci/database/models/create_autonomous_data_warehouse_details.py @@ -10,6 +10,8 @@ class CreateAutonomousDataWarehouseDetails(object): """ Details to create an Oracle Autonomous Data Warehouse. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. """ #: A constant which can be used with the license_model property of a CreateAutonomousDataWarehouseDetails. @@ -125,7 +127,9 @@ def admin_password(self, admin_password): def compartment_id(self): """ **[Required]** Gets the compartment_id of this CreateAutonomousDataWarehouseDetails. - The Oracle Cloud ID (OCID) of the compartment of the DB system. + The `OCID`__ of the compartment of the Autonomous Data Warehouse. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this CreateAutonomousDataWarehouseDetails. @@ -137,7 +141,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this CreateAutonomousDataWarehouseDetails. - The Oracle Cloud ID (OCID) of the compartment of the DB system. + The `OCID`__ of the compartment of the Autonomous Data Warehouse. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this CreateAutonomousDataWarehouseDetails. diff --git a/src/oci/database/models/create_autonomous_database_backup_details.py b/src/oci/database/models/create_autonomous_database_backup_details.py index dd7b0ac215..deb403d3cb 100644 --- a/src/oci/database/models/create_autonomous_database_backup_details.py +++ b/src/oci/database/models/create_autonomous_database_backup_details.py @@ -10,6 +10,8 @@ class CreateAutonomousDatabaseBackupDetails(object): """ Details to create an Oracle Autonomous Database backup. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. """ def __init__(self, **kwargs): diff --git a/src/oci/database/models/create_autonomous_database_details.py b/src/oci/database/models/create_autonomous_database_details.py index c831b8e9df..4fb51c1ae7 100644 --- a/src/oci/database/models/create_autonomous_database_details.py +++ b/src/oci/database/models/create_autonomous_database_details.py @@ -10,6 +10,8 @@ class CreateAutonomousDatabaseDetails(object): """ Details to create an Oracle Autonomous Database. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. """ #: A constant which can be used with the license_model property of a CreateAutonomousDatabaseDetails. @@ -125,7 +127,9 @@ def admin_password(self, admin_password): def compartment_id(self): """ **[Required]** Gets the compartment_id of this CreateAutonomousDatabaseDetails. - The Oracle Cloud ID (OCID) of the compartment of the DB system. + The `OCID`__ of the compartment of the autonomous database. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this CreateAutonomousDatabaseDetails. @@ -137,7 +141,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this CreateAutonomousDatabaseDetails. - The Oracle Cloud ID (OCID) of the compartment of the DB system. + The `OCID`__ of the compartment of the autonomous database. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this CreateAutonomousDatabaseDetails. @@ -173,7 +179,7 @@ def cpu_core_count(self, cpu_core_count): def data_storage_size_in_tbs(self): """ **[Required]** Gets the data_storage_size_in_tbs of this CreateAutonomousDatabaseDetails. - Size, in terabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. + The size, in terabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. :return: The data_storage_size_in_tbs of this CreateAutonomousDatabaseDetails. @@ -185,7 +191,7 @@ def data_storage_size_in_tbs(self): def data_storage_size_in_tbs(self, data_storage_size_in_tbs): """ Sets the data_storage_size_in_tbs of this CreateAutonomousDatabaseDetails. - Size, in terabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. + The size, in terabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. :param data_storage_size_in_tbs: The data_storage_size_in_tbs of this CreateAutonomousDatabaseDetails. diff --git a/src/oci/database/models/create_backup_details.py b/src/oci/database/models/create_backup_details.py index e214a78556..40a99569f1 100644 --- a/src/oci/database/models/create_backup_details.py +++ b/src/oci/database/models/create_backup_details.py @@ -9,7 +9,9 @@ @init_model_state_from_kwargs class CreateBackupDetails(object): """ - CreateBackupDetails model. + Details for creating a database backup. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. """ def __init__(self, **kwargs): @@ -43,7 +45,9 @@ def __init__(self, **kwargs): def database_id(self): """ **[Required]** Gets the database_id of this CreateBackupDetails. - The OCID of the database. + The `OCID`__ of the database. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The database_id of this CreateBackupDetails. @@ -55,7 +59,9 @@ def database_id(self): def database_id(self, database_id): """ Sets the database_id of this CreateBackupDetails. - The OCID of the database. + The `OCID`__ of the database. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param database_id: The database_id of this CreateBackupDetails. @@ -67,7 +73,7 @@ def database_id(self, database_id): def display_name(self): """ **[Required]** Gets the display_name of this CreateBackupDetails. - The user-friendly name for the backup. It does not have to be unique. + The user-friendly name for the backup. The name does not have to be unique. :return: The display_name of this CreateBackupDetails. @@ -79,7 +85,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this CreateBackupDetails. - The user-friendly name for the backup. It does not have to be unique. + The user-friendly name for the backup. The name does not have to be unique. :param display_name: The display_name of this CreateBackupDetails. diff --git a/src/oci/database/models/create_data_guard_association_to_existing_db_system_details.py b/src/oci/database/models/create_data_guard_association_to_existing_db_system_details.py index a353689666..e83fa084a4 100644 --- a/src/oci/database/models/create_data_guard_association_to_existing_db_system_details.py +++ b/src/oci/database/models/create_data_guard_association_to_existing_db_system_details.py @@ -68,7 +68,7 @@ def __init__(self, **kwargs): def peer_db_system_id(self): """ Gets the peer_db_system_id of this CreateDataGuardAssociationToExistingDbSystemDetails. - The `OCID`__ of the DB System to create the standby database on. + The `OCID`__ of the DB system to create the standby database on. __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm @@ -82,7 +82,7 @@ def peer_db_system_id(self): def peer_db_system_id(self, peer_db_system_id): """ Sets the peer_db_system_id of this CreateDataGuardAssociationToExistingDbSystemDetails. - The `OCID`__ of the DB System to create the standby database on. + The `OCID`__ of the DB system to create the standby database on. __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm diff --git a/src/oci/database/models/create_database_details.py b/src/oci/database/models/create_database_details.py index f0dd02b637..c62dbc2f0a 100644 --- a/src/oci/database/models/create_database_details.py +++ b/src/oci/database/models/create_database_details.py @@ -9,7 +9,9 @@ @init_model_state_from_kwargs class CreateDatabaseDetails(object): """ - CreateDatabaseDetails model. + Details for creating a database backup. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. """ #: A constant which can be used with the db_workload property of a CreateDatabaseDetails. @@ -127,7 +129,7 @@ def character_set(self): Gets the character_set of this CreateDatabaseDetails. The character set for the database. The default is AL32UTF8. Allowed values are: - AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS + AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS :return: The character_set of this CreateDatabaseDetails. @@ -141,7 +143,7 @@ def character_set(self, character_set): Sets the character_set of this CreateDatabaseDetails. The character set for the database. The default is AL32UTF8. Allowed values are: - AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS + AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS :param character_set: The character_set of this CreateDatabaseDetails. @@ -173,7 +175,7 @@ def db_backup_config(self, db_backup_config): def db_name(self): """ **[Required]** Gets the db_name of this CreateDatabaseDetails. - The database name. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. + The database name. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. :return: The db_name of this CreateDatabaseDetails. @@ -185,7 +187,7 @@ def db_name(self): def db_name(self, db_name): """ Sets the db_name of this CreateDatabaseDetails. - The database name. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. + The database name. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. :param db_name: The db_name of this CreateDatabaseDetails. @@ -197,7 +199,7 @@ def db_name(self, db_name): def db_workload(self): """ Gets the db_workload of this CreateDatabaseDetails. - Database workload type. + The database workload type. Allowed values for this property are: "OLTP", "DSS" @@ -211,7 +213,7 @@ def db_workload(self): def db_workload(self, db_workload): """ Sets the db_workload of this CreateDatabaseDetails. - Database workload type. + The database workload type. :param db_workload: The db_workload of this CreateDatabaseDetails. @@ -297,7 +299,7 @@ def freeform_tags(self, freeform_tags): def ncharacter_set(self): """ Gets the ncharacter_set of this CreateDatabaseDetails. - National character set for the database. The default is AL16UTF16. Allowed values are: + The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8. @@ -310,7 +312,7 @@ def ncharacter_set(self): def ncharacter_set(self, ncharacter_set): """ Sets the ncharacter_set of this CreateDatabaseDetails. - National character set for the database. The default is AL16UTF16. Allowed values are: + The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8. @@ -323,7 +325,7 @@ def ncharacter_set(self, ncharacter_set): def pdb_name(self): """ Gets the pdb_name of this CreateDatabaseDetails. - Pluggable database name. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. + The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. :return: The pdb_name of this CreateDatabaseDetails. @@ -335,7 +337,7 @@ def pdb_name(self): def pdb_name(self, pdb_name): """ Sets the pdb_name of this CreateDatabaseDetails. - Pluggable database name. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. + The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. :param pdb_name: The pdb_name of this CreateDatabaseDetails. diff --git a/src/oci/database/models/create_database_from_backup_details.py b/src/oci/database/models/create_database_from_backup_details.py index 9ed4f9f6e3..a2bf9ad639 100644 --- a/src/oci/database/models/create_database_from_backup_details.py +++ b/src/oci/database/models/create_database_from_backup_details.py @@ -74,7 +74,9 @@ def admin_password(self, admin_password): def backup_id(self): """ **[Required]** Gets the backup_id of this CreateDatabaseFromBackupDetails. - The backup OCID. + The backup `OCID`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The backup_id of this CreateDatabaseFromBackupDetails. @@ -86,7 +88,9 @@ def backup_id(self): def backup_id(self, backup_id): """ Sets the backup_id of this CreateDatabaseFromBackupDetails. - The backup OCID. + The backup `OCID`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param backup_id: The backup_id of this CreateDatabaseFromBackupDetails. diff --git a/src/oci/database/models/create_db_home_details.py b/src/oci/database/models/create_db_home_details.py index 11c441add3..0b7c5c1432 100644 --- a/src/oci/database/models/create_db_home_details.py +++ b/src/oci/database/models/create_db_home_details.py @@ -9,7 +9,9 @@ @init_model_state_from_kwargs class CreateDbHomeDetails(object): """ - CreateDbHomeDetails model. + Details for creating a database home. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. """ def __init__(self, **kwargs): @@ -70,7 +72,7 @@ def database(self, database): def db_version(self): """ **[Required]** Gets the db_version of this CreateDbHomeDetails. - A valid Oracle database version. To get a list of supported versions, use the :func:`list_db_versions` operation. + A valid Oracle Database version. To get a list of supported versions, use the :func:`list_db_versions` operation. :return: The db_version of this CreateDbHomeDetails. @@ -82,7 +84,7 @@ def db_version(self): def db_version(self, db_version): """ Sets the db_version of this CreateDbHomeDetails. - A valid Oracle database version. To get a list of supported versions, use the :func:`list_db_versions` operation. + A valid Oracle Database version. To get a list of supported versions, use the :func:`list_db_versions` operation. :param db_version: The db_version of this CreateDbHomeDetails. diff --git a/src/oci/database/models/create_db_home_from_backup_details.py b/src/oci/database/models/create_db_home_from_backup_details.py index 94eb7e780f..101f24aea9 100644 --- a/src/oci/database/models/create_db_home_from_backup_details.py +++ b/src/oci/database/models/create_db_home_from_backup_details.py @@ -9,7 +9,9 @@ @init_model_state_from_kwargs class CreateDbHomeFromBackupDetails(object): """ - CreateDbHomeFromBackupDetails model. + Details for creating a database home if you are creating a database by restoring from a database backup. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. """ def __init__(self, **kwargs): diff --git a/src/oci/database/models/create_db_home_with_db_system_id_base.py b/src/oci/database/models/create_db_home_with_db_system_id_base.py index 2697443777..8f66a6ec72 100644 --- a/src/oci/database/models/create_db_home_with_db_system_id_base.py +++ b/src/oci/database/models/create_db_home_with_db_system_id_base.py @@ -9,7 +9,9 @@ @init_model_state_from_kwargs class CreateDbHomeWithDbSystemIdBase(object): """ - CreateDbHomeWithDbSystemIdBase model. + Details for creating a database home. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. """ #: A constant which can be used with the source property of a CreateDbHomeWithDbSystemIdBase. @@ -80,7 +82,9 @@ def get_subtype(object_dictionary): def db_system_id(self): """ **[Required]** Gets the db_system_id of this CreateDbHomeWithDbSystemIdBase. - The OCID of the DB System. + The `OCID`__ of the DB system. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The db_system_id of this CreateDbHomeWithDbSystemIdBase. @@ -92,7 +96,9 @@ def db_system_id(self): def db_system_id(self, db_system_id): """ Sets the db_system_id of this CreateDbHomeWithDbSystemIdBase. - The OCID of the DB System. + The `OCID`__ of the DB system. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param db_system_id: The db_system_id of this CreateDbHomeWithDbSystemIdBase. @@ -128,9 +134,7 @@ def display_name(self, display_name): def source(self): """ Gets the source of this CreateDbHomeWithDbSystemIdBase. - Source of database: - NONE for creating a new database - DB_BACKUP for creating a new database by restoring a backup + The source of database: NONE for creating a new database. DB_BACKUP for creating a new database by restoring from a database backup. Allowed values for this property are: "NONE", "DB_BACKUP" @@ -144,9 +148,7 @@ def source(self): def source(self, source): """ Sets the source of this CreateDbHomeWithDbSystemIdBase. - Source of database: - NONE for creating a new database - DB_BACKUP for creating a new database by restoring a backup + The source of database: NONE for creating a new database. DB_BACKUP for creating a new database by restoring from a database backup. :param source: The source of this CreateDbHomeWithDbSystemIdBase. diff --git a/src/oci/database/models/create_db_home_with_db_system_id_details.py b/src/oci/database/models/create_db_home_with_db_system_id_details.py index f431ce8f78..c2d612f28b 100644 --- a/src/oci/database/models/create_db_home_with_db_system_id_details.py +++ b/src/oci/database/models/create_db_home_with_db_system_id_details.py @@ -87,7 +87,7 @@ def database(self, database): def db_version(self): """ **[Required]** Gets the db_version of this CreateDbHomeWithDbSystemIdDetails. - A valid Oracle database version. To get a list of supported versions, use the :func:`list_db_versions` operation. + A valid Oracle Database version. To get a list of supported versions, use the :func:`list_db_versions` operation. :return: The db_version of this CreateDbHomeWithDbSystemIdDetails. @@ -99,7 +99,7 @@ def db_version(self): def db_version(self, db_version): """ Sets the db_version of this CreateDbHomeWithDbSystemIdDetails. - A valid Oracle database version. To get a list of supported versions, use the :func:`list_db_versions` operation. + A valid Oracle Database version. To get a list of supported versions, use the :func:`list_db_versions` operation. :param db_version: The db_version of this CreateDbHomeWithDbSystemIdDetails. diff --git a/src/oci/database/models/data_guard_association.py b/src/oci/database/models/data_guard_association.py index c297409671..563891f66e 100644 --- a/src/oci/database/models/data_guard_association.py +++ b/src/oci/database/models/data_guard_association.py @@ -480,7 +480,7 @@ def peer_db_home_id(self, peer_db_home_id): def peer_db_system_id(self): """ **[Required]** Gets the peer_db_system_id of this DataGuardAssociation. - The `OCID`__ of the DB System containing the associated + The `OCID`__ of the DB system containing the associated peer database. __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm @@ -495,7 +495,7 @@ def peer_db_system_id(self): def peer_db_system_id(self, peer_db_system_id): """ Sets the peer_db_system_id of this DataGuardAssociation. - The `OCID`__ of the DB System containing the associated + The `OCID`__ of the DB system containing the associated peer database. __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm diff --git a/src/oci/database/models/data_guard_association_summary.py b/src/oci/database/models/data_guard_association_summary.py index 76d76f4e8e..39ba170a03 100644 --- a/src/oci/database/models/data_guard_association_summary.py +++ b/src/oci/database/models/data_guard_association_summary.py @@ -480,7 +480,7 @@ def peer_db_home_id(self, peer_db_home_id): def peer_db_system_id(self): """ **[Required]** Gets the peer_db_system_id of this DataGuardAssociationSummary. - The `OCID`__ of the DB System containing the associated + The `OCID`__ of the DB system containing the associated peer database. __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm @@ -495,7 +495,7 @@ def peer_db_system_id(self): def peer_db_system_id(self, peer_db_system_id): """ Sets the peer_db_system_id of this DataGuardAssociationSummary. - The `OCID`__ of the DB System containing the associated + The `OCID`__ of the DB system containing the associated peer database. __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm diff --git a/src/oci/database/models/database.py b/src/oci/database/models/database.py index 54eea8b3ad..84428538a2 100644 --- a/src/oci/database/models/database.py +++ b/src/oci/database/models/database.py @@ -9,10 +9,12 @@ @init_model_state_from_kwargs class Database(object): """ - An Oracle database on a DB System. For more information, see `Managing Oracle Databases`__. + An Oracle database on a bare metal or virtual machine DB system. For more information, see `Bare Metal and Virtual Machine DB Systems`__. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Database/Concepts/overview.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ @@ -197,7 +199,9 @@ def character_set(self, character_set): def compartment_id(self): """ **[Required]** Gets the compartment_id of this Database. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this Database. @@ -209,7 +213,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this Database. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this Database. @@ -241,7 +247,9 @@ def db_backup_config(self, db_backup_config): def db_home_id(self): """ Gets the db_home_id of this Database. - The OCID of the database home. + The `OCID`__ of the database home. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The db_home_id of this Database. @@ -253,7 +261,9 @@ def db_home_id(self): def db_home_id(self, db_home_id): """ Sets the db_home_id of this Database. - The OCID of the database home. + The `OCID`__ of the database home. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param db_home_id: The db_home_id of this Database. @@ -313,7 +323,7 @@ def db_unique_name(self, db_unique_name): def db_workload(self): """ Gets the db_workload of this Database. - Database workload type. + The database workload type. :return: The db_workload of this Database. @@ -325,7 +335,7 @@ def db_workload(self): def db_workload(self, db_workload): """ Sets the db_workload of this Database. - Database workload type. + The database workload type. :param db_workload: The db_workload of this Database. @@ -405,7 +415,9 @@ def freeform_tags(self, freeform_tags): def id(self): """ **[Required]** Gets the id of this Database. - The OCID of the database. + The `OCID`__ of the database. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The id of this Database. @@ -417,7 +429,9 @@ def id(self): def id(self, id): """ Sets the id of this Database. - The OCID of the database. + The `OCID`__ of the database. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param id: The id of this Database. @@ -507,7 +521,7 @@ def ncharacter_set(self, ncharacter_set): def pdb_name(self): """ Gets the pdb_name of this Database. - Pluggable database name. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. + The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. :return: The pdb_name of this Database. @@ -519,7 +533,7 @@ def pdb_name(self): def pdb_name(self, pdb_name): """ Sets the pdb_name of this Database. - Pluggable database name. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. + The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. :param pdb_name: The pdb_name of this Database. diff --git a/src/oci/database/models/database_summary.py b/src/oci/database/models/database_summary.py index e87843474b..1bcfbca604 100644 --- a/src/oci/database/models/database_summary.py +++ b/src/oci/database/models/database_summary.py @@ -9,10 +9,12 @@ @init_model_state_from_kwargs class DatabaseSummary(object): """ - An Oracle database on a DB System. For more information, see `Managing Oracle Databases`__. + An Oracle database on a bare metal or virtual machine DB system. For more information, see `Bare Metal and Virtual Machine DB Systems`__. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Database/Concepts/overview.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ @@ -197,7 +199,9 @@ def character_set(self, character_set): def compartment_id(self): """ **[Required]** Gets the compartment_id of this DatabaseSummary. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this DatabaseSummary. @@ -209,7 +213,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this DatabaseSummary. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this DatabaseSummary. @@ -241,7 +247,9 @@ def db_backup_config(self, db_backup_config): def db_home_id(self): """ Gets the db_home_id of this DatabaseSummary. - The OCID of the database home. + The `OCID`__ of the database home. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The db_home_id of this DatabaseSummary. @@ -253,7 +261,9 @@ def db_home_id(self): def db_home_id(self, db_home_id): """ Sets the db_home_id of this DatabaseSummary. - The OCID of the database home. + The `OCID`__ of the database home. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param db_home_id: The db_home_id of this DatabaseSummary. @@ -313,7 +323,7 @@ def db_unique_name(self, db_unique_name): def db_workload(self): """ Gets the db_workload of this DatabaseSummary. - Database workload type. + The database workload type. :return: The db_workload of this DatabaseSummary. @@ -325,7 +335,7 @@ def db_workload(self): def db_workload(self, db_workload): """ Sets the db_workload of this DatabaseSummary. - Database workload type. + The database workload type. :param db_workload: The db_workload of this DatabaseSummary. @@ -405,7 +415,9 @@ def freeform_tags(self, freeform_tags): def id(self): """ **[Required]** Gets the id of this DatabaseSummary. - The OCID of the database. + The `OCID`__ of the database. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The id of this DatabaseSummary. @@ -417,7 +429,9 @@ def id(self): def id(self, id): """ Sets the id of this DatabaseSummary. - The OCID of the database. + The `OCID`__ of the database. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param id: The id of this DatabaseSummary. @@ -507,7 +521,7 @@ def ncharacter_set(self, ncharacter_set): def pdb_name(self): """ Gets the pdb_name of this DatabaseSummary. - Pluggable database name. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. + The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. :return: The pdb_name of this DatabaseSummary. @@ -519,7 +533,7 @@ def pdb_name(self): def pdb_name(self, pdb_name): """ Sets the pdb_name of this DatabaseSummary. - Pluggable database name. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. + The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. :param pdb_name: The pdb_name of this DatabaseSummary. diff --git a/src/oci/database/models/db_home.py b/src/oci/database/models/db_home.py index e2ca6c18fe..86176851cd 100644 --- a/src/oci/database/models/db_home.py +++ b/src/oci/database/models/db_home.py @@ -9,15 +9,16 @@ @init_model_state_from_kwargs class DbHome(object): """ - A directory where Oracle database software is installed. Each DB System can have multiple database homes, - and each database home can have multiple databases within it. All the databases within a single database home - must be the same database version, but different database homes can run different versions. For more information, - see `Managing Oracle Databases`__. + A directory where Oracle Database software is installed. A bare metal DB system can have multiple database homes + and each database home can run a different supported version of Oracle Database. A virtual machine DB system can have only one database home. + For more information, see `Bare Metal and Virtual Machine DB Systems`__. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Database/Concepts/overview.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ @@ -121,7 +122,9 @@ def __init__(self, **kwargs): def compartment_id(self): """ **[Required]** Gets the compartment_id of this DbHome. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this DbHome. @@ -133,7 +136,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this DbHome. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this DbHome. @@ -145,7 +150,9 @@ def compartment_id(self, compartment_id): def db_system_id(self): """ Gets the db_system_id of this DbHome. - The OCID of the DB System. + The `OCID`__ of the DB system. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The db_system_id of this DbHome. @@ -157,7 +164,9 @@ def db_system_id(self): def db_system_id(self, db_system_id): """ Sets the db_system_id of this DbHome. - The OCID of the DB System. + The `OCID`__ of the DB system. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param db_system_id: The db_system_id of this DbHome. @@ -169,7 +178,7 @@ def db_system_id(self, db_system_id): def db_version(self): """ **[Required]** Gets the db_version of this DbHome. - The Oracle database version. + The Oracle Database version. :return: The db_version of this DbHome. @@ -181,7 +190,7 @@ def db_version(self): def db_version(self, db_version): """ Sets the db_version of this DbHome. - The Oracle database version. + The Oracle Database version. :param db_version: The db_version of this DbHome. @@ -193,7 +202,7 @@ def db_version(self, db_version): def display_name(self): """ **[Required]** Gets the display_name of this DbHome. - The user-provided name for the database home. It does not need to be unique. + The user-provided name for the database home. The name does not need to be unique. :return: The display_name of this DbHome. @@ -205,7 +214,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this DbHome. - The user-provided name for the database home. It does not need to be unique. + The user-provided name for the database home. The name does not need to be unique. :param display_name: The display_name of this DbHome. @@ -217,7 +226,9 @@ def display_name(self, display_name): def id(self): """ **[Required]** Gets the id of this DbHome. - The OCID of the database home. + The `OCID`__ of the database home. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The id of this DbHome. @@ -229,7 +240,9 @@ def id(self): def id(self, id): """ Sets the id of this DbHome. - The OCID of the database home. + The `OCID`__ of the database home. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param id: The id of this DbHome. @@ -241,7 +254,9 @@ def id(self, id): def last_patch_history_entry_id(self): """ Gets the last_patch_history_entry_id of this DbHome. - The OCID of the last patch history. This is updated as soon as a patch operation is started. + The `OCID`__ of the last patch history. This value is updated as soon as a patch operation is started. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The last_patch_history_entry_id of this DbHome. @@ -253,7 +268,9 @@ def last_patch_history_entry_id(self): def last_patch_history_entry_id(self, last_patch_history_entry_id): """ Sets the last_patch_history_entry_id of this DbHome. - The OCID of the last patch history. This is updated as soon as a patch operation is started. + The `OCID`__ of the last patch history. This value is updated as soon as a patch operation is started. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param last_patch_history_entry_id: The last_patch_history_entry_id of this DbHome. diff --git a/src/oci/database/models/db_home_summary.py b/src/oci/database/models/db_home_summary.py index fad9da3c3d..9c38965db4 100644 --- a/src/oci/database/models/db_home_summary.py +++ b/src/oci/database/models/db_home_summary.py @@ -9,15 +9,16 @@ @init_model_state_from_kwargs class DbHomeSummary(object): """ - A directory where Oracle database software is installed. Each DB System can have multiple database homes, - and each database home can have multiple databases within it. All the databases within a single database home - must be the same database version, but different database homes can run different versions. For more information, - see `Managing Oracle Databases`__. + A directory where Oracle Database software is installed. A bare metal DB system can have multiple database homes + and each database home can run a different supported version of Oracle Database. A virtual machine DB system can have only one database home. + For more information, see `Bare Metal and Virtual Machine DB Systems`__. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Database/Concepts/overview.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ @@ -121,7 +122,9 @@ def __init__(self, **kwargs): def compartment_id(self): """ **[Required]** Gets the compartment_id of this DbHomeSummary. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this DbHomeSummary. @@ -133,7 +136,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this DbHomeSummary. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this DbHomeSummary. @@ -145,7 +150,9 @@ def compartment_id(self, compartment_id): def db_system_id(self): """ Gets the db_system_id of this DbHomeSummary. - The OCID of the DB System. + The `OCID`__ of the DB system. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The db_system_id of this DbHomeSummary. @@ -157,7 +164,9 @@ def db_system_id(self): def db_system_id(self, db_system_id): """ Sets the db_system_id of this DbHomeSummary. - The OCID of the DB System. + The `OCID`__ of the DB system. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param db_system_id: The db_system_id of this DbHomeSummary. @@ -169,7 +178,7 @@ def db_system_id(self, db_system_id): def db_version(self): """ **[Required]** Gets the db_version of this DbHomeSummary. - The Oracle database version. + The Oracle Database version. :return: The db_version of this DbHomeSummary. @@ -181,7 +190,7 @@ def db_version(self): def db_version(self, db_version): """ Sets the db_version of this DbHomeSummary. - The Oracle database version. + The Oracle Database version. :param db_version: The db_version of this DbHomeSummary. @@ -193,7 +202,7 @@ def db_version(self, db_version): def display_name(self): """ **[Required]** Gets the display_name of this DbHomeSummary. - The user-provided name for the database home. It does not need to be unique. + The user-provided name for the database home. The name does not need to be unique. :return: The display_name of this DbHomeSummary. @@ -205,7 +214,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this DbHomeSummary. - The user-provided name for the database home. It does not need to be unique. + The user-provided name for the database home. The name does not need to be unique. :param display_name: The display_name of this DbHomeSummary. @@ -217,7 +226,9 @@ def display_name(self, display_name): def id(self): """ **[Required]** Gets the id of this DbHomeSummary. - The OCID of the database home. + The `OCID`__ of the database home. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The id of this DbHomeSummary. @@ -229,7 +240,9 @@ def id(self): def id(self, id): """ Sets the id of this DbHomeSummary. - The OCID of the database home. + The `OCID`__ of the database home. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param id: The id of this DbHomeSummary. @@ -241,7 +254,9 @@ def id(self, id): def last_patch_history_entry_id(self): """ Gets the last_patch_history_entry_id of this DbHomeSummary. - The OCID of the last patch history. This is updated as soon as a patch operation is started. + The `OCID`__ of the last patch history. This value is updated as soon as a patch operation is started. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The last_patch_history_entry_id of this DbHomeSummary. @@ -253,7 +268,9 @@ def last_patch_history_entry_id(self): def last_patch_history_entry_id(self, last_patch_history_entry_id): """ Sets the last_patch_history_entry_id of this DbHomeSummary. - The OCID of the last patch history. This is updated as soon as a patch operation is started. + The `OCID`__ of the last patch history. This value is updated as soon as a patch operation is started. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param last_patch_history_entry_id: The last_patch_history_entry_id of this DbHomeSummary. diff --git a/src/oci/database/models/db_node.py b/src/oci/database/models/db_node.py index 9de7914cb5..67fb1b9619 100644 --- a/src/oci/database/models/db_node.py +++ b/src/oci/database/models/db_node.py @@ -9,10 +9,12 @@ @init_model_state_from_kwargs class DbNode(object): """ - A server where Oracle database software is running. + A server where Oracle Database software is running. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ @@ -127,7 +129,9 @@ def __init__(self, **kwargs): def backup_vnic_id(self): """ Gets the backup_vnic_id of this DbNode. - The OCID of the backup VNIC. + The `OCID`__ of the backup VNIC. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The backup_vnic_id of this DbNode. @@ -139,7 +143,9 @@ def backup_vnic_id(self): def backup_vnic_id(self, backup_vnic_id): """ Sets the backup_vnic_id of this DbNode. - The OCID of the backup VNIC. + The `OCID`__ of the backup VNIC. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param backup_vnic_id: The backup_vnic_id of this DbNode. @@ -151,7 +157,9 @@ def backup_vnic_id(self, backup_vnic_id): def db_system_id(self): """ **[Required]** Gets the db_system_id of this DbNode. - The OCID of the DB System. + The `OCID`__ of the DB system. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The db_system_id of this DbNode. @@ -163,7 +171,9 @@ def db_system_id(self): def db_system_id(self, db_system_id): """ Sets the db_system_id of this DbNode. - The OCID of the DB System. + The `OCID`__ of the DB system. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param db_system_id: The db_system_id of this DbNode. @@ -175,7 +185,7 @@ def db_system_id(self, db_system_id): def hostname(self): """ Gets the hostname of this DbNode. - The host name for the DB Node. + The host name for the database node. :return: The hostname of this DbNode. @@ -187,7 +197,7 @@ def hostname(self): def hostname(self, hostname): """ Sets the hostname of this DbNode. - The host name for the DB Node. + The host name for the database node. :param hostname: The hostname of this DbNode. @@ -199,7 +209,9 @@ def hostname(self, hostname): def id(self): """ **[Required]** Gets the id of this DbNode. - The OCID of the DB Node. + The `OCID`__ of the database node. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The id of this DbNode. @@ -211,7 +223,9 @@ def id(self): def id(self, id): """ Sets the id of this DbNode. - The OCID of the DB Node. + The `OCID`__ of the database node. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param id: The id of this DbNode. @@ -253,7 +267,7 @@ def lifecycle_state(self, lifecycle_state): def software_storage_size_in_gb(self): """ Gets the software_storage_size_in_gb of this DbNode. - Storage size, in GBs, of the software volume that is allocated to the DB system. This is applicable only for VM-based DBs. + The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems. :return: The software_storage_size_in_gb of this DbNode. @@ -265,7 +279,7 @@ def software_storage_size_in_gb(self): def software_storage_size_in_gb(self, software_storage_size_in_gb): """ Sets the software_storage_size_in_gb of this DbNode. - Storage size, in GBs, of the software volume that is allocated to the DB system. This is applicable only for VM-based DBs. + The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems. :param software_storage_size_in_gb: The software_storage_size_in_gb of this DbNode. @@ -277,7 +291,7 @@ def software_storage_size_in_gb(self, software_storage_size_in_gb): def time_created(self): """ **[Required]** Gets the time_created of this DbNode. - The date and time that the DB Node was created. + The date and time that the database node was created. :return: The time_created of this DbNode. @@ -289,7 +303,7 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this DbNode. - The date and time that the DB Node was created. + The date and time that the database node was created. :param time_created: The time_created of this DbNode. @@ -301,7 +315,9 @@ def time_created(self, time_created): def vnic_id(self): """ **[Required]** Gets the vnic_id of this DbNode. - The OCID of the VNIC. + The `OCID`__ of the VNIC. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The vnic_id of this DbNode. @@ -313,7 +329,9 @@ def vnic_id(self): def vnic_id(self, vnic_id): """ Sets the vnic_id of this DbNode. - The OCID of the VNIC. + The `OCID`__ of the VNIC. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param vnic_id: The vnic_id of this DbNode. diff --git a/src/oci/database/models/db_node_summary.py b/src/oci/database/models/db_node_summary.py index 01c77e60d7..eaf6e36de9 100644 --- a/src/oci/database/models/db_node_summary.py +++ b/src/oci/database/models/db_node_summary.py @@ -9,10 +9,12 @@ @init_model_state_from_kwargs class DbNodeSummary(object): """ - A server where Oracle database software is running. + A server where Oracle Database software is running. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm """ @@ -127,7 +129,9 @@ def __init__(self, **kwargs): def backup_vnic_id(self): """ Gets the backup_vnic_id of this DbNodeSummary. - The OCID of the backup VNIC. + The `OCID`__ of the backup VNIC. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The backup_vnic_id of this DbNodeSummary. @@ -139,7 +143,9 @@ def backup_vnic_id(self): def backup_vnic_id(self, backup_vnic_id): """ Sets the backup_vnic_id of this DbNodeSummary. - The OCID of the backup VNIC. + The `OCID`__ of the backup VNIC. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param backup_vnic_id: The backup_vnic_id of this DbNodeSummary. @@ -151,7 +157,9 @@ def backup_vnic_id(self, backup_vnic_id): def db_system_id(self): """ **[Required]** Gets the db_system_id of this DbNodeSummary. - The OCID of the DB System. + The `OCID`__ of the DB system. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The db_system_id of this DbNodeSummary. @@ -163,7 +171,9 @@ def db_system_id(self): def db_system_id(self, db_system_id): """ Sets the db_system_id of this DbNodeSummary. - The OCID of the DB System. + The `OCID`__ of the DB system. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param db_system_id: The db_system_id of this DbNodeSummary. @@ -175,7 +185,7 @@ def db_system_id(self, db_system_id): def hostname(self): """ Gets the hostname of this DbNodeSummary. - The host name for the DB Node. + The host name for the database node. :return: The hostname of this DbNodeSummary. @@ -187,7 +197,7 @@ def hostname(self): def hostname(self, hostname): """ Sets the hostname of this DbNodeSummary. - The host name for the DB Node. + The host name for the database node. :param hostname: The hostname of this DbNodeSummary. @@ -199,7 +209,9 @@ def hostname(self, hostname): def id(self): """ **[Required]** Gets the id of this DbNodeSummary. - The OCID of the DB Node. + The `OCID`__ of the database node. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The id of this DbNodeSummary. @@ -211,7 +223,9 @@ def id(self): def id(self, id): """ Sets the id of this DbNodeSummary. - The OCID of the DB Node. + The `OCID`__ of the database node. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param id: The id of this DbNodeSummary. @@ -253,7 +267,7 @@ def lifecycle_state(self, lifecycle_state): def software_storage_size_in_gb(self): """ Gets the software_storage_size_in_gb of this DbNodeSummary. - Storage size, in GBs, of the software volume that is allocated to the DB system. This is applicable only for VM-based DBs. + The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems. :return: The software_storage_size_in_gb of this DbNodeSummary. @@ -265,7 +279,7 @@ def software_storage_size_in_gb(self): def software_storage_size_in_gb(self, software_storage_size_in_gb): """ Sets the software_storage_size_in_gb of this DbNodeSummary. - Storage size, in GBs, of the software volume that is allocated to the DB system. This is applicable only for VM-based DBs. + The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems. :param software_storage_size_in_gb: The software_storage_size_in_gb of this DbNodeSummary. @@ -277,7 +291,7 @@ def software_storage_size_in_gb(self, software_storage_size_in_gb): def time_created(self): """ **[Required]** Gets the time_created of this DbNodeSummary. - The date and time that the DB Node was created. + The date and time that the database node was created. :return: The time_created of this DbNodeSummary. @@ -289,7 +303,7 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this DbNodeSummary. - The date and time that the DB Node was created. + The date and time that the database node was created. :param time_created: The time_created of this DbNodeSummary. @@ -301,7 +315,9 @@ def time_created(self, time_created): def vnic_id(self): """ **[Required]** Gets the vnic_id of this DbNodeSummary. - The OCID of the VNIC. + The `OCID`__ of the VNIC. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The vnic_id of this DbNodeSummary. @@ -313,7 +329,9 @@ def vnic_id(self): def vnic_id(self, vnic_id): """ Sets the vnic_id of this DbNodeSummary. - The OCID of the VNIC. + The `OCID`__ of the VNIC. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param vnic_id: The vnic_id of this DbNodeSummary. diff --git a/src/oci/database/models/db_system.py b/src/oci/database/models/db_system.py index 863e0771b4..ad3be00414 100644 --- a/src/oci/database/models/db_system.py +++ b/src/oci/database/models/db_system.py @@ -9,22 +9,24 @@ @init_model_state_from_kwargs class DbSystem(object): """ - The Database Service supports several types of DB Systems, ranging in size, price, and performance. For details about each type of system, see: + The Database Service supports several types of DB systems, ranging in size, price, and performance. For details about each type of system, see: - `Exadata DB Systems`__ - `Bare Metal and Virtual Machine DB Systems`__ - To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. For information about access control and compartments, see `Overview of the Identity Service`__. - For information about Availability Domains, see + For information about availability domains, see `Regions and Availability Domains`__. - To get a list of Availability Domains, use the `ListAvailabilityDomains` operation + To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity Service API. + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Database/Concepts/exaoverview.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Database/Concepts/overview.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm @@ -40,14 +42,14 @@ class DbSystem(object): #: This constant has a value of "ENTERPRISE_EDITION" DATABASE_EDITION_ENTERPRISE_EDITION = "ENTERPRISE_EDITION" - #: A constant which can be used with the database_edition property of a DbSystem. - #: This constant has a value of "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" - DATABASE_EDITION_ENTERPRISE_EDITION_EXTREME_PERFORMANCE = "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" - #: A constant which can be used with the database_edition property of a DbSystem. #: This constant has a value of "ENTERPRISE_EDITION_HIGH_PERFORMANCE" DATABASE_EDITION_ENTERPRISE_EDITION_HIGH_PERFORMANCE = "ENTERPRISE_EDITION_HIGH_PERFORMANCE" + #: A constant which can be used with the database_edition property of a DbSystem. + #: This constant has a value of "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" + DATABASE_EDITION_ENTERPRISE_EDITION_EXTREME_PERFORMANCE = "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" + #: A constant which can be used with the disk_redundancy property of a DbSystem. #: This constant has a value of "HIGH" DISK_REDUNDANCY_HIGH = "HIGH" @@ -123,7 +125,7 @@ def __init__(self, **kwargs): :param database_edition: The value to assign to the database_edition property of this DbSystem. - Allowed values for this property are: "STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE", "ENTERPRISE_EDITION_HIGH_PERFORMANCE", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_HIGH_PERFORMANCE", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type database_edition: str @@ -323,7 +325,7 @@ def __init__(self, **kwargs): def availability_domain(self): """ **[Required]** Gets the availability_domain of this DbSystem. - The name of the Availability Domain that the DB System is located in. + The name of the availability domain that the DB system is located in. :return: The availability_domain of this DbSystem. @@ -335,7 +337,7 @@ def availability_domain(self): def availability_domain(self, availability_domain): """ Sets the availability_domain of this DbSystem. - The name of the Availability Domain that the DB System is located in. + The name of the availability domain that the DB system is located in. :param availability_domain: The availability_domain of this DbSystem. @@ -347,10 +349,11 @@ def availability_domain(self, availability_domain): def backup_subnet_id(self): """ Gets the backup_subnet_id of this DbSystem. - The OCID of the backup network subnet the DB System is associated with. Applicable only to Exadata. + The `OCID`__ of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems. + + **Subnet Restriction:** See the subnet restrictions information for **subnetId**. - **Subnet Restriction:** See above subnetId's 'Subnet Restriction'. - to malfunction. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The backup_subnet_id of this DbSystem. @@ -362,10 +365,11 @@ def backup_subnet_id(self): def backup_subnet_id(self, backup_subnet_id): """ Sets the backup_subnet_id of this DbSystem. - The OCID of the backup network subnet the DB System is associated with. Applicable only to Exadata. + The `OCID`__ of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems. - **Subnet Restriction:** See above subnetId's 'Subnet Restriction'. - to malfunction. + **Subnet Restriction:** See the subnet restrictions information for **subnetId**. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param backup_subnet_id: The backup_subnet_id of this DbSystem. @@ -377,7 +381,7 @@ def backup_subnet_id(self, backup_subnet_id): def cluster_name(self): """ Gets the cluster_name of this DbSystem. - Cluster name for Exadata and 2-node RAC DB Systems. The cluster name must begin with an an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. + The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. :return: The cluster_name of this DbSystem. @@ -389,7 +393,7 @@ def cluster_name(self): def cluster_name(self, cluster_name): """ Sets the cluster_name of this DbSystem. - Cluster name for Exadata and 2-node RAC DB Systems. The cluster name must begin with an an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. + The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. :param cluster_name: The cluster_name of this DbSystem. @@ -401,7 +405,9 @@ def cluster_name(self, cluster_name): def compartment_id(self): """ **[Required]** Gets the compartment_id of this DbSystem. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this DbSystem. @@ -413,7 +419,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this DbSystem. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this DbSystem. @@ -425,7 +433,7 @@ def compartment_id(self, compartment_id): def cpu_core_count(self): """ **[Required]** Gets the cpu_core_count of this DbSystem. - The number of CPU cores enabled on the DB System. + The number of CPU cores enabled on the DB system. :return: The cpu_core_count of this DbSystem. @@ -437,7 +445,7 @@ def cpu_core_count(self): def cpu_core_count(self, cpu_core_count): """ Sets the cpu_core_count of this DbSystem. - The number of CPU cores enabled on the DB System. + The number of CPU cores enabled on the DB system. :param cpu_core_count: The cpu_core_count of this DbSystem. @@ -450,7 +458,7 @@ def data_storage_percentage(self): """ Gets the data_storage_percentage of this DbSystem. The percentage assigned to DATA storage (user data and database files). - The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 40 and 80. + The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. :return: The data_storage_percentage of this DbSystem. @@ -463,7 +471,7 @@ def data_storage_percentage(self, data_storage_percentage): """ Sets the data_storage_percentage of this DbSystem. The percentage assigned to DATA storage (user data and database files). - The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 40 and 80. + The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. :param data_storage_percentage: The data_storage_percentage of this DbSystem. @@ -475,7 +483,7 @@ def data_storage_percentage(self, data_storage_percentage): def data_storage_size_in_gbs(self): """ Gets the data_storage_size_in_gbs of this DbSystem. - Data storage size, in GBs, that is currently available to the DB system. This is applicable only for VM-based DBs. + The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems. :return: The data_storage_size_in_gbs of this DbSystem. @@ -487,7 +495,7 @@ def data_storage_size_in_gbs(self): def data_storage_size_in_gbs(self, data_storage_size_in_gbs): """ Sets the data_storage_size_in_gbs of this DbSystem. - Data storage size, in GBs, that is currently available to the DB system. This is applicable only for VM-based DBs. + The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems. :param data_storage_size_in_gbs: The data_storage_size_in_gbs of this DbSystem. @@ -499,9 +507,9 @@ def data_storage_size_in_gbs(self, data_storage_size_in_gbs): def database_edition(self): """ **[Required]** Gets the database_edition of this DbSystem. - The Oracle Database Edition that applies to all the databases on the DB System. + The Oracle Database edition that applies to all the databases on the DB system. - Allowed values for this property are: "STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE", "ENTERPRISE_EDITION_HIGH_PERFORMANCE", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_HIGH_PERFORMANCE", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -514,13 +522,13 @@ def database_edition(self): def database_edition(self, database_edition): """ Sets the database_edition of this DbSystem. - The Oracle Database Edition that applies to all the databases on the DB System. + The Oracle Database edition that applies to all the databases on the DB system. :param database_edition: The database_edition of this DbSystem. :type: str """ - allowed_values = ["STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE", "ENTERPRISE_EDITION_HIGH_PERFORMANCE"] + allowed_values = ["STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_HIGH_PERFORMANCE", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE"] if not value_allowed_none_or_none_sentinel(database_edition, allowed_values): database_edition = 'UNKNOWN_ENUM_VALUE' self._database_edition = database_edition @@ -563,9 +571,9 @@ def defined_tags(self, defined_tags): def disk_redundancy(self): """ Gets the disk_redundancy of this DbSystem. - The type of redundancy configured for the DB System. - Normal is 2-way redundancy. - High is 3-way redundancy. + The type of redundancy configured for the DB system. + NORMAL is 2-way redundancy. + HIGH is 3-way redundancy. Allowed values for this property are: "HIGH", "NORMAL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -580,9 +588,9 @@ def disk_redundancy(self): def disk_redundancy(self, disk_redundancy): """ Sets the disk_redundancy of this DbSystem. - The type of redundancy configured for the DB System. - Normal is 2-way redundancy. - High is 3-way redundancy. + The type of redundancy configured for the DB system. + NORMAL is 2-way redundancy. + HIGH is 3-way redundancy. :param disk_redundancy: The disk_redundancy of this DbSystem. @@ -597,7 +605,7 @@ def disk_redundancy(self, disk_redundancy): def display_name(self): """ **[Required]** Gets the display_name of this DbSystem. - The user-friendly name for the DB System. It does not have to be unique. + The user-friendly name for the DB system. The name does not have to be unique. :return: The display_name of this DbSystem. @@ -609,7 +617,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this DbSystem. - The user-friendly name for the DB System. It does not have to be unique. + The user-friendly name for the DB system. The name does not have to be unique. :param display_name: The display_name of this DbSystem. @@ -621,7 +629,7 @@ def display_name(self, display_name): def domain(self): """ **[Required]** Gets the domain of this DbSystem. - The domain name for the DB System. + The domain name for the DB system. :return: The domain of this DbSystem. @@ -633,7 +641,7 @@ def domain(self): def domain(self, domain): """ Sets the domain of this DbSystem. - The domain name for the DB System. + The domain name for the DB system. :param domain: The domain of this DbSystem. @@ -679,7 +687,7 @@ def freeform_tags(self, freeform_tags): def hostname(self): """ **[Required]** Gets the hostname of this DbSystem. - The host name for the DB Node. + The hostname for the DB system. :return: The hostname of this DbSystem. @@ -691,7 +699,7 @@ def hostname(self): def hostname(self, hostname): """ Sets the hostname of this DbSystem. - The host name for the DB Node. + The hostname for the DB system. :param hostname: The hostname of this DbSystem. @@ -703,7 +711,9 @@ def hostname(self, hostname): def id(self): """ **[Required]** Gets the id of this DbSystem. - The OCID of the DB System. + The `OCID`__ of the DB system. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The id of this DbSystem. @@ -715,7 +725,9 @@ def id(self): def id(self, id): """ Sets the id of this DbSystem. - The OCID of the DB System. + The `OCID`__ of the DB system. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param id: The id of this DbSystem. @@ -727,7 +739,9 @@ def id(self, id): def last_patch_history_entry_id(self): """ Gets the last_patch_history_entry_id of this DbSystem. - The OCID of the last patch history. This is updated as soon as a patch operation is started. + The `OCID`__ of the last patch history. This value is updated as soon as a patch operation starts. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The last_patch_history_entry_id of this DbSystem. @@ -739,7 +753,9 @@ def last_patch_history_entry_id(self): def last_patch_history_entry_id(self, last_patch_history_entry_id): """ Sets the last_patch_history_entry_id of this DbSystem. - The OCID of the last patch history. This is updated as soon as a patch operation is started. + The `OCID`__ of the last patch history. This value is updated as soon as a patch operation starts. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param last_patch_history_entry_id: The last_patch_history_entry_id of this DbSystem. @@ -751,7 +767,7 @@ def last_patch_history_entry_id(self, last_patch_history_entry_id): def license_model(self): """ Gets the license_model of this DbSystem. - The Oracle license model that applies to all the databases on the DB System. The default is BRING_YOUR_OWN_LICENSE. + The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED. Allowed values for this property are: "LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -766,7 +782,7 @@ def license_model(self): def license_model(self, license_model): """ Sets the license_model of this DbSystem. - The Oracle license model that applies to all the databases on the DB System. The default is BRING_YOUR_OWN_LICENSE. + The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED. :param license_model: The license_model of this DbSystem. @@ -805,7 +821,7 @@ def lifecycle_details(self, lifecycle_details): def lifecycle_state(self): """ **[Required]** Gets the lifecycle_state of this DbSystem. - The current state of the DB System. + The current state of the DB system. Allowed values for this property are: "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -820,7 +836,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this DbSystem. - The current state of the DB System. + The current state of the DB system. :param lifecycle_state: The lifecycle_state of this DbSystem. @@ -835,7 +851,7 @@ def lifecycle_state(self, lifecycle_state): def listener_port(self): """ Gets the listener_port of this DbSystem. - The port number configured for the listener on the DB System. + The port number configured for the listener on the DB system. :return: The listener_port of this DbSystem. @@ -847,7 +863,7 @@ def listener_port(self): def listener_port(self, listener_port): """ Sets the listener_port of this DbSystem. - The port number configured for the listener on the DB System. + The port number configured for the listener on the DB system. :param listener_port: The listener_port of this DbSystem. @@ -859,7 +875,7 @@ def listener_port(self, listener_port): def node_count(self): """ Gets the node_count of this DbSystem. - Number of nodes in this DB system. For RAC DBs, this will be greater than 1. + The number of nodes in the DB system. For RAC DB systems, the value is greater than 1. :return: The node_count of this DbSystem. @@ -871,7 +887,7 @@ def node_count(self): def node_count(self, node_count): """ Sets the node_count of this DbSystem. - Number of nodes in this DB system. For RAC DBs, this will be greater than 1. + The number of nodes in the DB system. For RAC DB systems, the value is greater than 1. :param node_count: The node_count of this DbSystem. @@ -883,7 +899,7 @@ def node_count(self, node_count): def reco_storage_size_in_gb(self): """ Gets the reco_storage_size_in_gb of this DbSystem. - RECO/REDO storage size, in GBs, that is currently allocated to the DB system. This is applicable only for VM-based DBs. + The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems. :return: The reco_storage_size_in_gb of this DbSystem. @@ -895,7 +911,7 @@ def reco_storage_size_in_gb(self): def reco_storage_size_in_gb(self, reco_storage_size_in_gb): """ Sets the reco_storage_size_in_gb of this DbSystem. - RECO/REDO storage size, in GBs, that is currently allocated to the DB system. This is applicable only for VM-based DBs. + The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems. :param reco_storage_size_in_gb: The reco_storage_size_in_gb of this DbSystem. @@ -907,7 +923,9 @@ def reco_storage_size_in_gb(self, reco_storage_size_in_gb): def scan_dns_record_id(self): """ Gets the scan_dns_record_id of this DbSystem. - The OCID of the DNS record for the SCAN IP addresses that are associated with the DB System. + The `OCID`__ of the DNS record for the SCAN IP addresses that are associated with the DB system. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The scan_dns_record_id of this DbSystem. @@ -919,7 +937,9 @@ def scan_dns_record_id(self): def scan_dns_record_id(self, scan_dns_record_id): """ Sets the scan_dns_record_id of this DbSystem. - The OCID of the DNS record for the SCAN IP addresses that are associated with the DB System. + The `OCID`__ of the DNS record for the SCAN IP addresses that are associated with the DB system. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param scan_dns_record_id: The scan_dns_record_id of this DbSystem. @@ -931,11 +951,13 @@ def scan_dns_record_id(self, scan_dns_record_id): def scan_ip_ids(self): """ Gets the scan_ip_ids of this DbSystem. - The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB System. + The `OCID`__ of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. - Clusterware directs the requests to the appropriate nodes in the cluster. + Oracle Clusterware directs the requests to the appropriate nodes in the cluster. - - For a single-node DB System, this list is empty. + **Note:** For a single-node DB system, this list is empty. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The scan_ip_ids of this DbSystem. @@ -947,11 +969,13 @@ def scan_ip_ids(self): def scan_ip_ids(self, scan_ip_ids): """ Sets the scan_ip_ids of this DbSystem. - The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB System. + The `OCID`__ of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. - Clusterware directs the requests to the appropriate nodes in the cluster. + Oracle Clusterware directs the requests to the appropriate nodes in the cluster. + + **Note:** For a single-node DB system, this list is empty. - - For a single-node DB System, this list is empty. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param scan_ip_ids: The scan_ip_ids of this DbSystem. @@ -963,7 +987,9 @@ def scan_ip_ids(self, scan_ip_ids): def shape(self): """ **[Required]** Gets the shape of this DbSystem. - The shape of the DB System. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. + The shape of the DB system. The shape determines resources to allocate to the DB system. + - For virtual machine shapes, the number of CPU cores and memory + - For bare metal and Exadata shapes, the number of CPU cores, storage, and memory :return: The shape of this DbSystem. @@ -975,7 +1001,9 @@ def shape(self): def shape(self, shape): """ Sets the shape of this DbSystem. - The shape of the DB System. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. + The shape of the DB system. The shape determines resources to allocate to the DB system. + - For virtual machine shapes, the number of CPU cores and memory + - For bare metal and Exadata shapes, the number of CPU cores, storage, and memory :param shape: The shape of this DbSystem. @@ -987,7 +1015,7 @@ def shape(self, shape): def ssh_public_keys(self): """ **[Required]** Gets the ssh_public_keys of this DbSystem. - The public key portion of one or more key pairs used for SSH access to the DB System. + The public key portion of one or more key pairs used for SSH access to the DB system. :return: The ssh_public_keys of this DbSystem. @@ -999,7 +1027,7 @@ def ssh_public_keys(self): def ssh_public_keys(self, ssh_public_keys): """ Sets the ssh_public_keys of this DbSystem. - The public key portion of one or more key pairs used for SSH access to the DB System. + The public key portion of one or more key pairs used for SSH access to the DB system. :param ssh_public_keys: The ssh_public_keys of this DbSystem. @@ -1011,16 +1039,18 @@ def ssh_public_keys(self, ssh_public_keys): def subnet_id(self): """ **[Required]** Gets the subnet_id of this DbSystem. - The OCID of the subnet the DB System is associated with. + The `OCID`__ of the subnet the DB system is associated with. **Subnet Restrictions:** - - For single node and 2-node (RAC) DB Systems, do not use a subnet that overlaps with 192.168.16.16/28 - - For Exadata and VM-based RAC DB Systems, do not use a subnet that overlaps with 192.168.128.0/20 + - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. + - For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm + :return: The subnet_id of this DbSystem. :rtype: str @@ -1031,16 +1061,18 @@ def subnet_id(self): def subnet_id(self, subnet_id): """ Sets the subnet_id of this DbSystem. - The OCID of the subnet the DB System is associated with. + The `OCID`__ of the subnet the DB system is associated with. **Subnet Restrictions:** - - For single node and 2-node (RAC) DB Systems, do not use a subnet that overlaps with 192.168.16.16/28 - - For Exadata and VM-based RAC DB Systems, do not use a subnet that overlaps with 192.168.128.0/20 + - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. + - For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm + :param subnet_id: The subnet_id of this DbSystem. :type: str @@ -1051,7 +1083,7 @@ def subnet_id(self, subnet_id): def time_created(self): """ Gets the time_created of this DbSystem. - The date and time the DB System was created. + The date and time the DB system was created. :return: The time_created of this DbSystem. @@ -1063,7 +1095,7 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this DbSystem. - The date and time the DB System was created. + The date and time the DB system was created. :param time_created: The time_created of this DbSystem. @@ -1075,7 +1107,7 @@ def time_created(self, time_created): def version(self): """ Gets the version of this DbSystem. - The version of the DB System. + The Oracle Database version of the DB system. :return: The version of this DbSystem. @@ -1087,7 +1119,7 @@ def version(self): def version(self, version): """ Sets the version of this DbSystem. - The version of the DB System. + The Oracle Database version of the DB system. :param version: The version of this DbSystem. @@ -1099,11 +1131,13 @@ def version(self, version): def vip_ids(self): """ Gets the vip_ids of this DbSystem. - The OCID of the virtual IP (VIP) addresses associated with the DB System. - The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB System to + The `OCID`__ of the virtual IP (VIP) addresses associated with the DB system. + The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. - - For a single-node DB System, this list is empty. + **Note:** For a single-node DB system, this list is empty. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The vip_ids of this DbSystem. @@ -1115,11 +1149,13 @@ def vip_ids(self): def vip_ids(self, vip_ids): """ Sets the vip_ids of this DbSystem. - The OCID of the virtual IP (VIP) addresses associated with the DB System. - The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB System to + The `OCID`__ of the virtual IP (VIP) addresses associated with the DB system. + The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. - - For a single-node DB System, this list is empty. + **Note:** For a single-node DB system, this list is empty. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param vip_ids: The vip_ids of this DbSystem. diff --git a/src/oci/database/models/db_system_shape_summary.py b/src/oci/database/models/db_system_shape_summary.py index c025a81a31..7acd5bbb40 100644 --- a/src/oci/database/models/db_system_shape_summary.py +++ b/src/oci/database/models/db_system_shape_summary.py @@ -9,7 +9,7 @@ @init_model_state_from_kwargs class DbSystemShapeSummary(object): """ - The shape of the DB System. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. + The shape of the DB system. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. For a description of shapes, see `DB System Launch Options`__. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, @@ -85,7 +85,7 @@ def __init__(self, **kwargs): def available_core_count(self): """ **[Required]** Gets the available_core_count of this DbSystemShapeSummary. - The maximum number of CPU cores that can be enabled on the DB System for this shape. + The maximum number of CPU cores that can be enabled on the DB system for this shape. :return: The available_core_count of this DbSystemShapeSummary. @@ -97,7 +97,7 @@ def available_core_count(self): def available_core_count(self, available_core_count): """ Sets the available_core_count of this DbSystemShapeSummary. - The maximum number of CPU cores that can be enabled on the DB System for this shape. + The maximum number of CPU cores that can be enabled on the DB system for this shape. :param available_core_count: The available_core_count of this DbSystemShapeSummary. @@ -157,7 +157,7 @@ def maximum_node_count(self, maximum_node_count): def minimum_core_count(self): """ Gets the minimum_core_count of this DbSystemShapeSummary. - The minimum number of CPU cores that can be enabled on the DB System for this shape. + The minimum number of CPU cores that can be enabled on the DB system for this shape. :return: The minimum_core_count of this DbSystemShapeSummary. @@ -169,7 +169,7 @@ def minimum_core_count(self): def minimum_core_count(self, minimum_core_count): """ Sets the minimum_core_count of this DbSystemShapeSummary. - The minimum number of CPU cores that can be enabled on the DB System for this shape. + The minimum number of CPU cores that can be enabled on the DB system for this shape. :param minimum_core_count: The minimum_core_count of this DbSystemShapeSummary. @@ -205,7 +205,7 @@ def minimum_node_count(self, minimum_node_count): def name(self): """ **[Required]** Gets the name of this DbSystemShapeSummary. - The name of the shape used for the DB System. + The name of the shape used for the DB system. :return: The name of this DbSystemShapeSummary. @@ -217,7 +217,7 @@ def name(self): def name(self, name): """ Sets the name of this DbSystemShapeSummary. - The name of the shape used for the DB System. + The name of the shape used for the DB system. :param name: The name of this DbSystemShapeSummary. diff --git a/src/oci/database/models/db_system_summary.py b/src/oci/database/models/db_system_summary.py index c82a0e1e31..23a4aa1a6e 100644 --- a/src/oci/database/models/db_system_summary.py +++ b/src/oci/database/models/db_system_summary.py @@ -9,22 +9,24 @@ @init_model_state_from_kwargs class DbSystemSummary(object): """ - The Database Service supports several types of DB Systems, ranging in size, price, and performance. For details about each type of system, see: + The Database Service supports several types of DB systems, ranging in size, price, and performance. For details about each type of system, see: - `Exadata DB Systems`__ - `Bare Metal and Virtual Machine DB Systems`__ - To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. For information about access control and compartments, see `Overview of the Identity Service`__. - For information about Availability Domains, see + For information about availability domains, see `Regions and Availability Domains`__. - To get a list of Availability Domains, use the `ListAvailabilityDomains` operation + To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity Service API. + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Database/Concepts/exaoverview.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Database/Concepts/overview.htm __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm @@ -40,14 +42,14 @@ class DbSystemSummary(object): #: This constant has a value of "ENTERPRISE_EDITION" DATABASE_EDITION_ENTERPRISE_EDITION = "ENTERPRISE_EDITION" - #: A constant which can be used with the database_edition property of a DbSystemSummary. - #: This constant has a value of "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" - DATABASE_EDITION_ENTERPRISE_EDITION_EXTREME_PERFORMANCE = "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" - #: A constant which can be used with the database_edition property of a DbSystemSummary. #: This constant has a value of "ENTERPRISE_EDITION_HIGH_PERFORMANCE" DATABASE_EDITION_ENTERPRISE_EDITION_HIGH_PERFORMANCE = "ENTERPRISE_EDITION_HIGH_PERFORMANCE" + #: A constant which can be used with the database_edition property of a DbSystemSummary. + #: This constant has a value of "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" + DATABASE_EDITION_ENTERPRISE_EDITION_EXTREME_PERFORMANCE = "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" + #: A constant which can be used with the disk_redundancy property of a DbSystemSummary. #: This constant has a value of "HIGH" DISK_REDUNDANCY_HIGH = "HIGH" @@ -123,7 +125,7 @@ def __init__(self, **kwargs): :param database_edition: The value to assign to the database_edition property of this DbSystemSummary. - Allowed values for this property are: "STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE", "ENTERPRISE_EDITION_HIGH_PERFORMANCE", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_HIGH_PERFORMANCE", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type database_edition: str @@ -323,7 +325,7 @@ def __init__(self, **kwargs): def availability_domain(self): """ **[Required]** Gets the availability_domain of this DbSystemSummary. - The name of the Availability Domain that the DB System is located in. + The name of the availability domain that the DB system is located in. :return: The availability_domain of this DbSystemSummary. @@ -335,7 +337,7 @@ def availability_domain(self): def availability_domain(self, availability_domain): """ Sets the availability_domain of this DbSystemSummary. - The name of the Availability Domain that the DB System is located in. + The name of the availability domain that the DB system is located in. :param availability_domain: The availability_domain of this DbSystemSummary. @@ -347,10 +349,11 @@ def availability_domain(self, availability_domain): def backup_subnet_id(self): """ Gets the backup_subnet_id of this DbSystemSummary. - The OCID of the backup network subnet the DB System is associated with. Applicable only to Exadata. + The `OCID`__ of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems. + + **Subnet Restriction:** See the subnet restrictions information for **subnetId**. - **Subnet Restriction:** See above subnetId's 'Subnet Restriction'. - to malfunction. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The backup_subnet_id of this DbSystemSummary. @@ -362,10 +365,11 @@ def backup_subnet_id(self): def backup_subnet_id(self, backup_subnet_id): """ Sets the backup_subnet_id of this DbSystemSummary. - The OCID of the backup network subnet the DB System is associated with. Applicable only to Exadata. + The `OCID`__ of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems. - **Subnet Restriction:** See above subnetId's 'Subnet Restriction'. - to malfunction. + **Subnet Restriction:** See the subnet restrictions information for **subnetId**. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param backup_subnet_id: The backup_subnet_id of this DbSystemSummary. @@ -377,7 +381,7 @@ def backup_subnet_id(self, backup_subnet_id): def cluster_name(self): """ Gets the cluster_name of this DbSystemSummary. - Cluster name for Exadata and 2-node RAC DB Systems. The cluster name must begin with an an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. + The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. :return: The cluster_name of this DbSystemSummary. @@ -389,7 +393,7 @@ def cluster_name(self): def cluster_name(self, cluster_name): """ Sets the cluster_name of this DbSystemSummary. - Cluster name for Exadata and 2-node RAC DB Systems. The cluster name must begin with an an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. + The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. :param cluster_name: The cluster_name of this DbSystemSummary. @@ -401,7 +405,9 @@ def cluster_name(self, cluster_name): def compartment_id(self): """ **[Required]** Gets the compartment_id of this DbSystemSummary. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this DbSystemSummary. @@ -413,7 +419,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this DbSystemSummary. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this DbSystemSummary. @@ -425,7 +433,7 @@ def compartment_id(self, compartment_id): def cpu_core_count(self): """ **[Required]** Gets the cpu_core_count of this DbSystemSummary. - The number of CPU cores enabled on the DB System. + The number of CPU cores enabled on the DB system. :return: The cpu_core_count of this DbSystemSummary. @@ -437,7 +445,7 @@ def cpu_core_count(self): def cpu_core_count(self, cpu_core_count): """ Sets the cpu_core_count of this DbSystemSummary. - The number of CPU cores enabled on the DB System. + The number of CPU cores enabled on the DB system. :param cpu_core_count: The cpu_core_count of this DbSystemSummary. @@ -450,7 +458,7 @@ def data_storage_percentage(self): """ Gets the data_storage_percentage of this DbSystemSummary. The percentage assigned to DATA storage (user data and database files). - The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 40 and 80. + The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. :return: The data_storage_percentage of this DbSystemSummary. @@ -463,7 +471,7 @@ def data_storage_percentage(self, data_storage_percentage): """ Sets the data_storage_percentage of this DbSystemSummary. The percentage assigned to DATA storage (user data and database files). - The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 40 and 80. + The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. :param data_storage_percentage: The data_storage_percentage of this DbSystemSummary. @@ -475,7 +483,7 @@ def data_storage_percentage(self, data_storage_percentage): def data_storage_size_in_gbs(self): """ Gets the data_storage_size_in_gbs of this DbSystemSummary. - Data storage size, in GBs, that is currently available to the DB system. This is applicable only for VM-based DBs. + The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems. :return: The data_storage_size_in_gbs of this DbSystemSummary. @@ -487,7 +495,7 @@ def data_storage_size_in_gbs(self): def data_storage_size_in_gbs(self, data_storage_size_in_gbs): """ Sets the data_storage_size_in_gbs of this DbSystemSummary. - Data storage size, in GBs, that is currently available to the DB system. This is applicable only for VM-based DBs. + The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems. :param data_storage_size_in_gbs: The data_storage_size_in_gbs of this DbSystemSummary. @@ -499,9 +507,9 @@ def data_storage_size_in_gbs(self, data_storage_size_in_gbs): def database_edition(self): """ **[Required]** Gets the database_edition of this DbSystemSummary. - The Oracle Database Edition that applies to all the databases on the DB System. + The Oracle Database edition that applies to all the databases on the DB system. - Allowed values for this property are: "STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE", "ENTERPRISE_EDITION_HIGH_PERFORMANCE", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_HIGH_PERFORMANCE", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -514,13 +522,13 @@ def database_edition(self): def database_edition(self, database_edition): """ Sets the database_edition of this DbSystemSummary. - The Oracle Database Edition that applies to all the databases on the DB System. + The Oracle Database edition that applies to all the databases on the DB system. :param database_edition: The database_edition of this DbSystemSummary. :type: str """ - allowed_values = ["STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE", "ENTERPRISE_EDITION_HIGH_PERFORMANCE"] + allowed_values = ["STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_HIGH_PERFORMANCE", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE"] if not value_allowed_none_or_none_sentinel(database_edition, allowed_values): database_edition = 'UNKNOWN_ENUM_VALUE' self._database_edition = database_edition @@ -563,9 +571,9 @@ def defined_tags(self, defined_tags): def disk_redundancy(self): """ Gets the disk_redundancy of this DbSystemSummary. - The type of redundancy configured for the DB System. - Normal is 2-way redundancy. - High is 3-way redundancy. + The type of redundancy configured for the DB system. + NORMAL is 2-way redundancy. + HIGH is 3-way redundancy. Allowed values for this property are: "HIGH", "NORMAL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -580,9 +588,9 @@ def disk_redundancy(self): def disk_redundancy(self, disk_redundancy): """ Sets the disk_redundancy of this DbSystemSummary. - The type of redundancy configured for the DB System. - Normal is 2-way redundancy. - High is 3-way redundancy. + The type of redundancy configured for the DB system. + NORMAL is 2-way redundancy. + HIGH is 3-way redundancy. :param disk_redundancy: The disk_redundancy of this DbSystemSummary. @@ -597,7 +605,7 @@ def disk_redundancy(self, disk_redundancy): def display_name(self): """ **[Required]** Gets the display_name of this DbSystemSummary. - The user-friendly name for the DB System. It does not have to be unique. + The user-friendly name for the DB system. The name does not have to be unique. :return: The display_name of this DbSystemSummary. @@ -609,7 +617,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this DbSystemSummary. - The user-friendly name for the DB System. It does not have to be unique. + The user-friendly name for the DB system. The name does not have to be unique. :param display_name: The display_name of this DbSystemSummary. @@ -621,7 +629,7 @@ def display_name(self, display_name): def domain(self): """ **[Required]** Gets the domain of this DbSystemSummary. - The domain name for the DB System. + The domain name for the DB system. :return: The domain of this DbSystemSummary. @@ -633,7 +641,7 @@ def domain(self): def domain(self, domain): """ Sets the domain of this DbSystemSummary. - The domain name for the DB System. + The domain name for the DB system. :param domain: The domain of this DbSystemSummary. @@ -679,7 +687,7 @@ def freeform_tags(self, freeform_tags): def hostname(self): """ **[Required]** Gets the hostname of this DbSystemSummary. - The host name for the DB Node. + The hostname for the DB system. :return: The hostname of this DbSystemSummary. @@ -691,7 +699,7 @@ def hostname(self): def hostname(self, hostname): """ Sets the hostname of this DbSystemSummary. - The host name for the DB Node. + The hostname for the DB system. :param hostname: The hostname of this DbSystemSummary. @@ -703,7 +711,9 @@ def hostname(self, hostname): def id(self): """ **[Required]** Gets the id of this DbSystemSummary. - The OCID of the DB System. + The `OCID`__ of the DB system. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The id of this DbSystemSummary. @@ -715,7 +725,9 @@ def id(self): def id(self, id): """ Sets the id of this DbSystemSummary. - The OCID of the DB System. + The `OCID`__ of the DB system. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param id: The id of this DbSystemSummary. @@ -727,7 +739,9 @@ def id(self, id): def last_patch_history_entry_id(self): """ Gets the last_patch_history_entry_id of this DbSystemSummary. - The OCID of the last patch history. This is updated as soon as a patch operation is started. + The `OCID`__ of the last patch history. This value is updated as soon as a patch operation starts. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The last_patch_history_entry_id of this DbSystemSummary. @@ -739,7 +753,9 @@ def last_patch_history_entry_id(self): def last_patch_history_entry_id(self, last_patch_history_entry_id): """ Sets the last_patch_history_entry_id of this DbSystemSummary. - The OCID of the last patch history. This is updated as soon as a patch operation is started. + The `OCID`__ of the last patch history. This value is updated as soon as a patch operation starts. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param last_patch_history_entry_id: The last_patch_history_entry_id of this DbSystemSummary. @@ -751,7 +767,7 @@ def last_patch_history_entry_id(self, last_patch_history_entry_id): def license_model(self): """ Gets the license_model of this DbSystemSummary. - The Oracle license model that applies to all the databases on the DB System. The default is BRING_YOUR_OWN_LICENSE. + The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED. Allowed values for this property are: "LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -766,7 +782,7 @@ def license_model(self): def license_model(self, license_model): """ Sets the license_model of this DbSystemSummary. - The Oracle license model that applies to all the databases on the DB System. The default is BRING_YOUR_OWN_LICENSE. + The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED. :param license_model: The license_model of this DbSystemSummary. @@ -805,7 +821,7 @@ def lifecycle_details(self, lifecycle_details): def lifecycle_state(self): """ **[Required]** Gets the lifecycle_state of this DbSystemSummary. - The current state of the DB System. + The current state of the DB system. Allowed values for this property are: "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -820,7 +836,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this DbSystemSummary. - The current state of the DB System. + The current state of the DB system. :param lifecycle_state: The lifecycle_state of this DbSystemSummary. @@ -835,7 +851,7 @@ def lifecycle_state(self, lifecycle_state): def listener_port(self): """ Gets the listener_port of this DbSystemSummary. - The port number configured for the listener on the DB System. + The port number configured for the listener on the DB system. :return: The listener_port of this DbSystemSummary. @@ -847,7 +863,7 @@ def listener_port(self): def listener_port(self, listener_port): """ Sets the listener_port of this DbSystemSummary. - The port number configured for the listener on the DB System. + The port number configured for the listener on the DB system. :param listener_port: The listener_port of this DbSystemSummary. @@ -859,7 +875,7 @@ def listener_port(self, listener_port): def node_count(self): """ Gets the node_count of this DbSystemSummary. - Number of nodes in this DB system. For RAC DBs, this will be greater than 1. + The number of nodes in the DB system. For RAC DB systems, the value is greater than 1. :return: The node_count of this DbSystemSummary. @@ -871,7 +887,7 @@ def node_count(self): def node_count(self, node_count): """ Sets the node_count of this DbSystemSummary. - Number of nodes in this DB system. For RAC DBs, this will be greater than 1. + The number of nodes in the DB system. For RAC DB systems, the value is greater than 1. :param node_count: The node_count of this DbSystemSummary. @@ -883,7 +899,7 @@ def node_count(self, node_count): def reco_storage_size_in_gb(self): """ Gets the reco_storage_size_in_gb of this DbSystemSummary. - RECO/REDO storage size, in GBs, that is currently allocated to the DB system. This is applicable only for VM-based DBs. + The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems. :return: The reco_storage_size_in_gb of this DbSystemSummary. @@ -895,7 +911,7 @@ def reco_storage_size_in_gb(self): def reco_storage_size_in_gb(self, reco_storage_size_in_gb): """ Sets the reco_storage_size_in_gb of this DbSystemSummary. - RECO/REDO storage size, in GBs, that is currently allocated to the DB system. This is applicable only for VM-based DBs. + The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems. :param reco_storage_size_in_gb: The reco_storage_size_in_gb of this DbSystemSummary. @@ -907,7 +923,9 @@ def reco_storage_size_in_gb(self, reco_storage_size_in_gb): def scan_dns_record_id(self): """ Gets the scan_dns_record_id of this DbSystemSummary. - The OCID of the DNS record for the SCAN IP addresses that are associated with the DB System. + The `OCID`__ of the DNS record for the SCAN IP addresses that are associated with the DB system. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The scan_dns_record_id of this DbSystemSummary. @@ -919,7 +937,9 @@ def scan_dns_record_id(self): def scan_dns_record_id(self, scan_dns_record_id): """ Sets the scan_dns_record_id of this DbSystemSummary. - The OCID of the DNS record for the SCAN IP addresses that are associated with the DB System. + The `OCID`__ of the DNS record for the SCAN IP addresses that are associated with the DB system. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param scan_dns_record_id: The scan_dns_record_id of this DbSystemSummary. @@ -931,11 +951,13 @@ def scan_dns_record_id(self, scan_dns_record_id): def scan_ip_ids(self): """ Gets the scan_ip_ids of this DbSystemSummary. - The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB System. + The `OCID`__ of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. - Clusterware directs the requests to the appropriate nodes in the cluster. + Oracle Clusterware directs the requests to the appropriate nodes in the cluster. - - For a single-node DB System, this list is empty. + **Note:** For a single-node DB system, this list is empty. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The scan_ip_ids of this DbSystemSummary. @@ -947,11 +969,13 @@ def scan_ip_ids(self): def scan_ip_ids(self, scan_ip_ids): """ Sets the scan_ip_ids of this DbSystemSummary. - The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB System. + The `OCID`__ of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. - Clusterware directs the requests to the appropriate nodes in the cluster. + Oracle Clusterware directs the requests to the appropriate nodes in the cluster. + + **Note:** For a single-node DB system, this list is empty. - - For a single-node DB System, this list is empty. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param scan_ip_ids: The scan_ip_ids of this DbSystemSummary. @@ -963,7 +987,9 @@ def scan_ip_ids(self, scan_ip_ids): def shape(self): """ **[Required]** Gets the shape of this DbSystemSummary. - The shape of the DB System. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. + The shape of the DB system. The shape determines resources to allocate to the DB system. + - For virtual machine shapes, the number of CPU cores and memory + - For bare metal and Exadata shapes, the number of CPU cores, storage, and memory :return: The shape of this DbSystemSummary. @@ -975,7 +1001,9 @@ def shape(self): def shape(self, shape): """ Sets the shape of this DbSystemSummary. - The shape of the DB System. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. + The shape of the DB system. The shape determines resources to allocate to the DB system. + - For virtual machine shapes, the number of CPU cores and memory + - For bare metal and Exadata shapes, the number of CPU cores, storage, and memory :param shape: The shape of this DbSystemSummary. @@ -987,7 +1015,7 @@ def shape(self, shape): def ssh_public_keys(self): """ **[Required]** Gets the ssh_public_keys of this DbSystemSummary. - The public key portion of one or more key pairs used for SSH access to the DB System. + The public key portion of one or more key pairs used for SSH access to the DB system. :return: The ssh_public_keys of this DbSystemSummary. @@ -999,7 +1027,7 @@ def ssh_public_keys(self): def ssh_public_keys(self, ssh_public_keys): """ Sets the ssh_public_keys of this DbSystemSummary. - The public key portion of one or more key pairs used for SSH access to the DB System. + The public key portion of one or more key pairs used for SSH access to the DB system. :param ssh_public_keys: The ssh_public_keys of this DbSystemSummary. @@ -1011,16 +1039,18 @@ def ssh_public_keys(self, ssh_public_keys): def subnet_id(self): """ **[Required]** Gets the subnet_id of this DbSystemSummary. - The OCID of the subnet the DB System is associated with. + The `OCID`__ of the subnet the DB system is associated with. **Subnet Restrictions:** - - For single node and 2-node (RAC) DB Systems, do not use a subnet that overlaps with 192.168.16.16/28 - - For Exadata and VM-based RAC DB Systems, do not use a subnet that overlaps with 192.168.128.0/20 + - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. + - For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm + :return: The subnet_id of this DbSystemSummary. :rtype: str @@ -1031,16 +1061,18 @@ def subnet_id(self): def subnet_id(self, subnet_id): """ Sets the subnet_id of this DbSystemSummary. - The OCID of the subnet the DB System is associated with. + The `OCID`__ of the subnet the DB system is associated with. **Subnet Restrictions:** - - For single node and 2-node (RAC) DB Systems, do not use a subnet that overlaps with 192.168.16.16/28 - - For Exadata and VM-based RAC DB Systems, do not use a subnet that overlaps with 192.168.128.0/20 + - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. + - For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm + :param subnet_id: The subnet_id of this DbSystemSummary. :type: str @@ -1051,7 +1083,7 @@ def subnet_id(self, subnet_id): def time_created(self): """ Gets the time_created of this DbSystemSummary. - The date and time the DB System was created. + The date and time the DB system was created. :return: The time_created of this DbSystemSummary. @@ -1063,7 +1095,7 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this DbSystemSummary. - The date and time the DB System was created. + The date and time the DB system was created. :param time_created: The time_created of this DbSystemSummary. @@ -1075,7 +1107,7 @@ def time_created(self, time_created): def version(self): """ Gets the version of this DbSystemSummary. - The version of the DB System. + The Oracle Database version of the DB system. :return: The version of this DbSystemSummary. @@ -1087,7 +1119,7 @@ def version(self): def version(self, version): """ Sets the version of this DbSystemSummary. - The version of the DB System. + The Oracle Database version of the DB system. :param version: The version of this DbSystemSummary. @@ -1099,11 +1131,13 @@ def version(self, version): def vip_ids(self): """ Gets the vip_ids of this DbSystemSummary. - The OCID of the virtual IP (VIP) addresses associated with the DB System. - The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB System to + The `OCID`__ of the virtual IP (VIP) addresses associated with the DB system. + The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. - - For a single-node DB System, this list is empty. + **Note:** For a single-node DB system, this list is empty. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The vip_ids of this DbSystemSummary. @@ -1115,11 +1149,13 @@ def vip_ids(self): def vip_ids(self, vip_ids): """ Sets the vip_ids of this DbSystemSummary. - The OCID of the virtual IP (VIP) addresses associated with the DB System. - The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB System to + The `OCID`__ of the virtual IP (VIP) addresses associated with the DB system. + The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. - - For a single-node DB System, this list is empty. + **Note:** For a single-node DB system, this list is empty. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param vip_ids: The vip_ids of this DbSystemSummary. diff --git a/src/oci/database/models/db_version_summary.py b/src/oci/database/models/db_version_summary.py index 1c19abea2e..0144f18b60 100644 --- a/src/oci/database/models/db_version_summary.py +++ b/src/oci/database/models/db_version_summary.py @@ -47,7 +47,7 @@ def __init__(self, **kwargs): def supports_pdb(self): """ Gets the supports_pdb of this DbVersionSummary. - True if this version of the Oracle database software supports pluggable dbs. + True if this version of the Oracle Database software supports pluggable databases. :return: The supports_pdb of this DbVersionSummary. @@ -59,7 +59,7 @@ def supports_pdb(self): def supports_pdb(self, supports_pdb): """ Sets the supports_pdb of this DbVersionSummary. - True if this version of the Oracle database software supports pluggable dbs. + True if this version of the Oracle Database software supports pluggable databases. :param supports_pdb: The supports_pdb of this DbVersionSummary. @@ -71,7 +71,7 @@ def supports_pdb(self, supports_pdb): def version(self): """ **[Required]** Gets the version of this DbVersionSummary. - A valid Oracle database version. + A valid Oracle Database version. :return: The version of this DbVersionSummary. @@ -83,7 +83,7 @@ def version(self): def version(self, version): """ Sets the version of this DbVersionSummary. - A valid Oracle database version. + A valid Oracle Database version. :param version: The version of this DbVersionSummary. diff --git a/src/oci/database/models/failover_data_guard_association_details.py b/src/oci/database/models/failover_data_guard_association_details.py index c5238b3804..a704596b11 100644 --- a/src/oci/database/models/failover_data_guard_association_details.py +++ b/src/oci/database/models/failover_data_guard_association_details.py @@ -36,7 +36,7 @@ def __init__(self, **kwargs): def database_admin_password(self): """ **[Required]** Gets the database_admin_password of this FailoverDataGuardAssociationDetails. - The DB System administrator password. + The DB system administrator password. :return: The database_admin_password of this FailoverDataGuardAssociationDetails. @@ -48,7 +48,7 @@ def database_admin_password(self): def database_admin_password(self, database_admin_password): """ Sets the database_admin_password of this FailoverDataGuardAssociationDetails. - The DB System administrator password. + The DB system administrator password. :param database_admin_password: The database_admin_password of this FailoverDataGuardAssociationDetails. diff --git a/src/oci/database/models/launch_db_system_base.py b/src/oci/database/models/launch_db_system_base.py index cfd9e5ed45..0a4bce874c 100644 --- a/src/oci/database/models/launch_db_system_base.py +++ b/src/oci/database/models/launch_db_system_base.py @@ -9,7 +9,9 @@ @init_model_state_from_kwargs class LaunchDbSystemBase(object): """ - LaunchDbSystemBase model. + Parameters for provisioning a bare metal, virtual machine, or Exadata DB system. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. """ #: A constant which can be used with the source property of a LaunchDbSystemBase. @@ -178,7 +180,7 @@ def get_subtype(object_dictionary): def availability_domain(self): """ **[Required]** Gets the availability_domain of this LaunchDbSystemBase. - The Availability Domain where the DB System is located. + The availability domain where the DB system is located. :return: The availability_domain of this LaunchDbSystemBase. @@ -190,7 +192,7 @@ def availability_domain(self): def availability_domain(self, availability_domain): """ Sets the availability_domain of this LaunchDbSystemBase. - The Availability Domain where the DB System is located. + The availability domain where the DB system is located. :param availability_domain: The availability_domain of this LaunchDbSystemBase. @@ -202,9 +204,11 @@ def availability_domain(self, availability_domain): def backup_subnet_id(self): """ Gets the backup_subnet_id of this LaunchDbSystemBase. - The OCID of the backup network subnet the DB System is associated with. Applicable only to Exadata. + The `OCID`__ of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems. + + **Subnet Restrictions:** See the subnet restrictions information for **subnetId**. - **Subnet Restrictions:** See above subnetId's **Subnet Restriction**. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The backup_subnet_id of this LaunchDbSystemBase. @@ -216,9 +220,11 @@ def backup_subnet_id(self): def backup_subnet_id(self, backup_subnet_id): """ Sets the backup_subnet_id of this LaunchDbSystemBase. - The OCID of the backup network subnet the DB System is associated with. Applicable only to Exadata. + The `OCID`__ of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems. + + **Subnet Restrictions:** See the subnet restrictions information for **subnetId**. - **Subnet Restrictions:** See above subnetId's **Subnet Restriction**. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param backup_subnet_id: The backup_subnet_id of this LaunchDbSystemBase. @@ -230,7 +236,7 @@ def backup_subnet_id(self, backup_subnet_id): def cluster_name(self): """ Gets the cluster_name of this LaunchDbSystemBase. - Cluster name for Exadata and 2-node RAC DB Systems. The cluster name must begin with an an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. + The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. :return: The cluster_name of this LaunchDbSystemBase. @@ -242,7 +248,7 @@ def cluster_name(self): def cluster_name(self, cluster_name): """ Sets the cluster_name of this LaunchDbSystemBase. - Cluster name for Exadata and 2-node RAC DB Systems. The cluster name must begin with an an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. + The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. :param cluster_name: The cluster_name of this LaunchDbSystemBase. @@ -254,7 +260,9 @@ def cluster_name(self, cluster_name): def compartment_id(self): """ **[Required]** Gets the compartment_id of this LaunchDbSystemBase. - The Oracle Cloud ID (OCID) of the compartment the DB System belongs in. + The `OCID`__ of the compartment the DB system belongs in. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this LaunchDbSystemBase. @@ -266,7 +274,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this LaunchDbSystemBase. - The Oracle Cloud ID (OCID) of the compartment the DB System belongs in. + The `OCID`__ of the compartment the DB system belongs in. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this LaunchDbSystemBase. @@ -278,15 +288,21 @@ def compartment_id(self, compartment_id): def cpu_core_count(self): """ **[Required]** Gets the cpu_core_count of this LaunchDbSystemBase. - The number of CPU cores to enable. The valid values depend on the specified shape: + The number of CPU cores to enable for a bare metal or Exadata DB system. The valid values depend on the specified shape: - - BM.DenseIO1.36 and BM.HighIO1.36 - Specify a multiple of 2, from 2 to 36. - - BM.RACLocalStorage1.72 - Specify a multiple of 4, from 4 to 72. + - BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36. + - BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52. - Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84. - Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168. - Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336. + - Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92. + - Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184. + - Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368. + + This parameter is not used for virtual machine DB systems because virtual machine DB systems have a set number of cores for each shape. + For information about the number of cores for a virtual machine DB system shape, see `Virtual Machine DB Systems`__ - For VM DB systems, the core count is inferred from the specific VM shape chosen, so this parameter is not used. + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Database/Concepts/overview.htm#virtualmachine :return: The cpu_core_count of this LaunchDbSystemBase. @@ -298,15 +314,21 @@ def cpu_core_count(self): def cpu_core_count(self, cpu_core_count): """ Sets the cpu_core_count of this LaunchDbSystemBase. - The number of CPU cores to enable. The valid values depend on the specified shape: + The number of CPU cores to enable for a bare metal or Exadata DB system. The valid values depend on the specified shape: - - BM.DenseIO1.36 and BM.HighIO1.36 - Specify a multiple of 2, from 2 to 36. - - BM.RACLocalStorage1.72 - Specify a multiple of 4, from 4 to 72. + - BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36. + - BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52. - Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84. - Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168. - Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336. + - Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92. + - Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184. + - Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368. - For VM DB systems, the core count is inferred from the specific VM shape chosen, so this parameter is not used. + This parameter is not used for virtual machine DB systems because virtual machine DB systems have a set number of cores for each shape. + For information about the number of cores for a virtual machine DB system shape, see `Virtual Machine DB Systems`__ + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Database/Concepts/overview.htm#virtualmachine :param cpu_core_count: The cpu_core_count of this LaunchDbSystemBase. @@ -320,7 +342,7 @@ def data_storage_percentage(self): Gets the data_storage_percentage of this LaunchDbSystemBase. The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). - Specify 80 or 40. The default is 80 percent assigned to DATA storage. This is not applicable for VM based DB systems. + Specify 80 or 40. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. :return: The data_storage_percentage of this LaunchDbSystemBase. @@ -334,7 +356,7 @@ def data_storage_percentage(self, data_storage_percentage): Sets the data_storage_percentage of this LaunchDbSystemBase. The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). - Specify 80 or 40. The default is 80 percent assigned to DATA storage. This is not applicable for VM based DB systems. + Specify 80 or 40. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. :param data_storage_percentage: The data_storage_percentage of this LaunchDbSystemBase. @@ -380,7 +402,7 @@ def defined_tags(self, defined_tags): def display_name(self): """ Gets the display_name of this LaunchDbSystemBase. - The user-friendly name for the DB System. It does not have to be unique. + The user-friendly name for the DB system. The name does not have to be unique. :return: The display_name of this LaunchDbSystemBase. @@ -392,7 +414,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this LaunchDbSystemBase. - The user-friendly name for the DB System. It does not have to be unique. + The user-friendly name for the DB system. The name does not have to be unique. :param display_name: The display_name of this LaunchDbSystemBase. @@ -404,9 +426,9 @@ def display_name(self, display_name): def domain(self): """ Gets the domain of this LaunchDbSystemBase. - A domain name used for the DB System. If the Oracle-provided Internet and VCN + A domain name used for the DB system. If the Oracle-provided Internet and VCN Resolver is enabled for the specified subnet, the domain name for the subnet is used - (don't provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. + (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. :return: The domain of this LaunchDbSystemBase. @@ -418,9 +440,9 @@ def domain(self): def domain(self, domain): """ Sets the domain of this LaunchDbSystemBase. - A domain name used for the DB System. If the Oracle-provided Internet and VCN + A domain name used for the DB system. If the Oracle-provided Internet and VCN Resolver is enabled for the specified subnet, the domain name for the subnet is used - (don't provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. + (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. :param domain: The domain of this LaunchDbSystemBase. @@ -466,13 +488,13 @@ def freeform_tags(self, freeform_tags): def hostname(self): """ **[Required]** Gets the hostname of this LaunchDbSystemBase. - The host name for the DB System. The host name must begin with an alphabetic character and + The hostname for the DB system. The hostname must begin with an alphabetic character and can contain a maximum of 30 alphanumeric characters, including hyphens (-). The maximum length of the combined hostname and domain is 63 characters. **Note:** The hostname must be unique within the subnet. If it is not unique, - the DB System will fail to provision. + the DB system will fail to provision. :return: The hostname of this LaunchDbSystemBase. @@ -484,13 +506,13 @@ def hostname(self): def hostname(self, hostname): """ Sets the hostname of this LaunchDbSystemBase. - The host name for the DB System. The host name must begin with an alphabetic character and + The hostname for the DB system. The hostname must begin with an alphabetic character and can contain a maximum of 30 alphanumeric characters, including hyphens (-). The maximum length of the combined hostname and domain is 63 characters. **Note:** The hostname must be unique within the subnet. If it is not unique, - the DB System will fail to provision. + the DB system will fail to provision. :param hostname: The hostname of this LaunchDbSystemBase. @@ -502,7 +524,7 @@ def hostname(self, hostname): def initial_data_storage_size_in_gb(self): """ Gets the initial_data_storage_size_in_gb of this LaunchDbSystemBase. - Size, in GBs, of the initial data volume that will be created and attached to VM-shape based DB system. This storage can later be scaled up if needed. Note that the total storage size attached will be more than what is requested, to account for REDO/RECO space and software volume. + Size (in GB) of the initial data volume that will be created and attached to a virtual machine DB system. You can scale up storage after provisioning, as needed. Note that the total storage size attached will be more than the amount you specify to allow for REDO/RECO space and software volume. :return: The initial_data_storage_size_in_gb of this LaunchDbSystemBase. @@ -514,7 +536,7 @@ def initial_data_storage_size_in_gb(self): def initial_data_storage_size_in_gb(self, initial_data_storage_size_in_gb): """ Sets the initial_data_storage_size_in_gb of this LaunchDbSystemBase. - Size, in GBs, of the initial data volume that will be created and attached to VM-shape based DB system. This storage can later be scaled up if needed. Note that the total storage size attached will be more than what is requested, to account for REDO/RECO space and software volume. + Size (in GB) of the initial data volume that will be created and attached to a virtual machine DB system. You can scale up storage after provisioning, as needed. Note that the total storage size attached will be more than the amount you specify to allow for REDO/RECO space and software volume. :param initial_data_storage_size_in_gb: The initial_data_storage_size_in_gb of this LaunchDbSystemBase. @@ -526,7 +548,7 @@ def initial_data_storage_size_in_gb(self, initial_data_storage_size_in_gb): def node_count(self): """ Gets the node_count of this LaunchDbSystemBase. - Number of nodes to launch for a VM-shape based RAC DB system. + The number of nodes to launch for a 2-node RAC virtual machine DB system. :return: The node_count of this LaunchDbSystemBase. @@ -538,7 +560,7 @@ def node_count(self): def node_count(self, node_count): """ Sets the node_count of this LaunchDbSystemBase. - Number of nodes to launch for a VM-shape based RAC DB system. + The number of nodes to launch for a 2-node RAC virtual machine DB system. :param node_count: The node_count of this LaunchDbSystemBase. @@ -550,7 +572,11 @@ def node_count(self, node_count): def shape(self): """ **[Required]** Gets the shape of this LaunchDbSystemBase. - The shape of the DB System. The shape determines resources allocated to the DB System - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. To get a list of shapes, use the :func:`list_db_system_shapes` operation. + The shape of the DB system. The shape determines resources allocated to the DB system. + - For virtual machine shapes, the number of CPU cores and memory + - For bare metal and Exadata shapes, the number of CPU cores, memory, and storage + + To get a list of shapes, use the :func:`list_db_system_shapes` operation. :return: The shape of this LaunchDbSystemBase. @@ -562,7 +588,11 @@ def shape(self): def shape(self, shape): """ Sets the shape of this LaunchDbSystemBase. - The shape of the DB System. The shape determines resources allocated to the DB System - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. To get a list of shapes, use the :func:`list_db_system_shapes` operation. + The shape of the DB system. The shape determines resources allocated to the DB system. + - For virtual machine shapes, the number of CPU cores and memory + - For bare metal and Exadata shapes, the number of CPU cores, memory, and storage + + To get a list of shapes, use the :func:`list_db_system_shapes` operation. :param shape: The shape of this LaunchDbSystemBase. @@ -574,9 +604,8 @@ def shape(self, shape): def source(self): """ Gets the source of this LaunchDbSystemBase. - Source of database: - NONE for creating a new database - DB_BACKUP for creating a new database by restoring a backup + The source of the database: + NONE for creating a new database. DB_BACKUP for creating a new database by restoring from a backup. The default is NONE. Allowed values for this property are: "NONE", "DB_BACKUP" @@ -590,9 +619,8 @@ def source(self): def source(self, source): """ Sets the source of this LaunchDbSystemBase. - Source of database: - NONE for creating a new database - DB_BACKUP for creating a new database by restoring a backup + The source of the database: + NONE for creating a new database. DB_BACKUP for creating a new database by restoring from a backup. The default is NONE. :param source: The source of this LaunchDbSystemBase. @@ -610,7 +638,7 @@ def source(self, source): def ssh_public_keys(self): """ **[Required]** Gets the ssh_public_keys of this LaunchDbSystemBase. - The public key portion of the key pair to use for SSH access to the DB System. Multiple public keys can be provided. The length of the combined keys cannot exceed 10,000 characters. + The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 10,000 characters. :return: The ssh_public_keys of this LaunchDbSystemBase. @@ -622,7 +650,7 @@ def ssh_public_keys(self): def ssh_public_keys(self, ssh_public_keys): """ Sets the ssh_public_keys of this LaunchDbSystemBase. - The public key portion of the key pair to use for SSH access to the DB System. Multiple public keys can be provided. The length of the combined keys cannot exceed 10,000 characters. + The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 10,000 characters. :param ssh_public_keys: The ssh_public_keys of this LaunchDbSystemBase. @@ -634,15 +662,17 @@ def ssh_public_keys(self, ssh_public_keys): def subnet_id(self): """ **[Required]** Gets the subnet_id of this LaunchDbSystemBase. - The OCID of the subnet the DB System is associated with. + The `OCID`__ of the subnet the DB system is associated with. **Subnet Restrictions:** - - For single node and 2-node (RAC) DB Systems, do not use a subnet that overlaps with 192.168.16.16/28 - - For Exadata and VM-based RAC DB Systems, do not use a subnet that overlaps with 192.168.128.0/20 + - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. + - For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. - This restriction applies to both the client subnet and backup subnet. + This restriction applies to both the client subnet and the backup subnet. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The subnet_id of this LaunchDbSystemBase. @@ -654,15 +684,17 @@ def subnet_id(self): def subnet_id(self, subnet_id): """ Sets the subnet_id of this LaunchDbSystemBase. - The OCID of the subnet the DB System is associated with. + The `OCID`__ of the subnet the DB system is associated with. **Subnet Restrictions:** - - For single node and 2-node (RAC) DB Systems, do not use a subnet that overlaps with 192.168.16.16/28 - - For Exadata and VM-based RAC DB Systems, do not use a subnet that overlaps with 192.168.128.0/20 + - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. + - For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. - This restriction applies to both the client subnet and backup subnet. + This restriction applies to both the client subnet and the backup subnet. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param subnet_id: The subnet_id of this LaunchDbSystemBase. diff --git a/src/oci/database/models/launch_db_system_details.py b/src/oci/database/models/launch_db_system_details.py index e4ad797068..8c11be46db 100644 --- a/src/oci/database/models/launch_db_system_details.py +++ b/src/oci/database/models/launch_db_system_details.py @@ -20,14 +20,14 @@ class LaunchDbSystemDetails(LaunchDbSystemBase): #: This constant has a value of "ENTERPRISE_EDITION" DATABASE_EDITION_ENTERPRISE_EDITION = "ENTERPRISE_EDITION" - #: A constant which can be used with the database_edition property of a LaunchDbSystemDetails. - #: This constant has a value of "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" - DATABASE_EDITION_ENTERPRISE_EDITION_EXTREME_PERFORMANCE = "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" - #: A constant which can be used with the database_edition property of a LaunchDbSystemDetails. #: This constant has a value of "ENTERPRISE_EDITION_HIGH_PERFORMANCE" DATABASE_EDITION_ENTERPRISE_EDITION_HIGH_PERFORMANCE = "ENTERPRISE_EDITION_HIGH_PERFORMANCE" + #: A constant which can be used with the database_edition property of a LaunchDbSystemDetails. + #: This constant has a value of "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" + DATABASE_EDITION_ENTERPRISE_EDITION_EXTREME_PERFORMANCE = "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" + #: A constant which can be used with the disk_redundancy property of a LaunchDbSystemDetails. #: This constant has a value of "HIGH" DISK_REDUNDANCY_HIGH = "HIGH" @@ -121,7 +121,7 @@ def __init__(self, **kwargs): :param database_edition: The value to assign to the database_edition property of this LaunchDbSystemDetails. - Allowed values for this property are: "STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE", "ENTERPRISE_EDITION_HIGH_PERFORMANCE" + Allowed values for this property are: "STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_HIGH_PERFORMANCE", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" :type database_edition: str :param db_home: @@ -214,10 +214,10 @@ def __init__(self, **kwargs): def database_edition(self): """ **[Required]** Gets the database_edition of this LaunchDbSystemDetails. - The Oracle Database Edition that applies to all the databases on the DB System. - Exadata DB Systems and 2-node RAC DB Systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. + The Oracle Database Edition that applies to all the databases on the DB system. + Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. - Allowed values for this property are: "STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE", "ENTERPRISE_EDITION_HIGH_PERFORMANCE" + Allowed values for this property are: "STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_HIGH_PERFORMANCE", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" :return: The database_edition of this LaunchDbSystemDetails. @@ -229,14 +229,14 @@ def database_edition(self): def database_edition(self, database_edition): """ Sets the database_edition of this LaunchDbSystemDetails. - The Oracle Database Edition that applies to all the databases on the DB System. - Exadata DB Systems and 2-node RAC DB Systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. + The Oracle Database Edition that applies to all the databases on the DB system. + Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. :param database_edition: The database_edition of this LaunchDbSystemDetails. :type: str """ - allowed_values = ["STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE", "ENTERPRISE_EDITION_HIGH_PERFORMANCE"] + allowed_values = ["STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_HIGH_PERFORMANCE", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE"] if not value_allowed_none_or_none_sentinel(database_edition, allowed_values): raise ValueError( "Invalid value for `database_edition`, must be None or one of {0}" @@ -268,7 +268,7 @@ def db_home(self, db_home): def disk_redundancy(self): """ Gets the disk_redundancy of this LaunchDbSystemDetails. - The type of redundancy configured for the DB System. + The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems. @@ -284,7 +284,7 @@ def disk_redundancy(self): def disk_redundancy(self, disk_redundancy): """ Sets the disk_redundancy of this LaunchDbSystemDetails. - The type of redundancy configured for the DB System. + The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems. @@ -304,7 +304,7 @@ def disk_redundancy(self, disk_redundancy): def license_model(self): """ Gets the license_model of this LaunchDbSystemDetails. - The Oracle license model that applies to all the databases on the DB System. The default is BRING_YOUR_OWN_LICENSE. + The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED. Allowed values for this property are: "LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE" @@ -318,7 +318,7 @@ def license_model(self): def license_model(self, license_model): """ Sets the license_model of this LaunchDbSystemDetails. - The Oracle license model that applies to all the databases on the DB System. The default is BRING_YOUR_OWN_LICENSE. + The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED. :param license_model: The license_model of this LaunchDbSystemDetails. diff --git a/src/oci/database/models/launch_db_system_from_backup_details.py b/src/oci/database/models/launch_db_system_from_backup_details.py index 877bacfee5..8e89aaadce 100644 --- a/src/oci/database/models/launch_db_system_from_backup_details.py +++ b/src/oci/database/models/launch_db_system_from_backup_details.py @@ -20,14 +20,14 @@ class LaunchDbSystemFromBackupDetails(LaunchDbSystemBase): #: This constant has a value of "ENTERPRISE_EDITION" DATABASE_EDITION_ENTERPRISE_EDITION = "ENTERPRISE_EDITION" - #: A constant which can be used with the database_edition property of a LaunchDbSystemFromBackupDetails. - #: This constant has a value of "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" - DATABASE_EDITION_ENTERPRISE_EDITION_EXTREME_PERFORMANCE = "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" - #: A constant which can be used with the database_edition property of a LaunchDbSystemFromBackupDetails. #: This constant has a value of "ENTERPRISE_EDITION_HIGH_PERFORMANCE" DATABASE_EDITION_ENTERPRISE_EDITION_HIGH_PERFORMANCE = "ENTERPRISE_EDITION_HIGH_PERFORMANCE" + #: A constant which can be used with the database_edition property of a LaunchDbSystemFromBackupDetails. + #: This constant has a value of "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" + DATABASE_EDITION_ENTERPRISE_EDITION_EXTREME_PERFORMANCE = "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" + #: A constant which can be used with the disk_redundancy property of a LaunchDbSystemFromBackupDetails. #: This constant has a value of "HIGH" DISK_REDUNDANCY_HIGH = "HIGH" @@ -121,7 +121,7 @@ def __init__(self, **kwargs): :param database_edition: The value to assign to the database_edition property of this LaunchDbSystemFromBackupDetails. - Allowed values for this property are: "STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE", "ENTERPRISE_EDITION_HIGH_PERFORMANCE" + Allowed values for this property are: "STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_HIGH_PERFORMANCE", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" :type database_edition: str :param db_home: @@ -214,10 +214,10 @@ def __init__(self, **kwargs): def database_edition(self): """ **[Required]** Gets the database_edition of this LaunchDbSystemFromBackupDetails. - The Oracle Database Edition that applies to all the databases on the DB System. - Exadata DB Systems and 2-node RAC DB Systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. + The Oracle Database Edition that applies to all the databases on the DB system. + Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. - Allowed values for this property are: "STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE", "ENTERPRISE_EDITION_HIGH_PERFORMANCE" + Allowed values for this property are: "STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_HIGH_PERFORMANCE", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" :return: The database_edition of this LaunchDbSystemFromBackupDetails. @@ -229,14 +229,14 @@ def database_edition(self): def database_edition(self, database_edition): """ Sets the database_edition of this LaunchDbSystemFromBackupDetails. - The Oracle Database Edition that applies to all the databases on the DB System. - Exadata DB Systems and 2-node RAC DB Systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. + The Oracle Database Edition that applies to all the databases on the DB system. + Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. :param database_edition: The database_edition of this LaunchDbSystemFromBackupDetails. :type: str """ - allowed_values = ["STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE", "ENTERPRISE_EDITION_HIGH_PERFORMANCE"] + allowed_values = ["STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_HIGH_PERFORMANCE", "ENTERPRISE_EDITION_EXTREME_PERFORMANCE"] if not value_allowed_none_or_none_sentinel(database_edition, allowed_values): raise ValueError( "Invalid value for `database_edition`, must be None or one of {0}" @@ -268,9 +268,9 @@ def db_home(self, db_home): def disk_redundancy(self): """ Gets the disk_redundancy of this LaunchDbSystemFromBackupDetails. - The type of redundancy configured for the DB System. - Normal is 2-way redundancy, recommended for test and development systems. - High is 3-way redundancy, recommended for production systems. + The type of redundancy configured for the DB system. + NORMAL 2-way redundancy, recommended for test and development systems. + HIGH is 3-way redundancy, recommended for production systems. Allowed values for this property are: "HIGH", "NORMAL" @@ -284,9 +284,9 @@ def disk_redundancy(self): def disk_redundancy(self, disk_redundancy): """ Sets the disk_redundancy of this LaunchDbSystemFromBackupDetails. - The type of redundancy configured for the DB System. - Normal is 2-way redundancy, recommended for test and development systems. - High is 3-way redundancy, recommended for production systems. + The type of redundancy configured for the DB system. + NORMAL 2-way redundancy, recommended for test and development systems. + HIGH is 3-way redundancy, recommended for production systems. :param disk_redundancy: The disk_redundancy of this LaunchDbSystemFromBackupDetails. @@ -304,7 +304,7 @@ def disk_redundancy(self, disk_redundancy): def license_model(self): """ Gets the license_model of this LaunchDbSystemFromBackupDetails. - The Oracle license model that applies to all the databases on the DB System. The default is BRING_YOUR_OWN_LICENSE. + The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED. Allowed values for this property are: "LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE" @@ -318,7 +318,7 @@ def license_model(self): def license_model(self, license_model): """ Sets the license_model of this LaunchDbSystemFromBackupDetails. - The Oracle license model that applies to all the databases on the DB System. The default is BRING_YOUR_OWN_LICENSE. + The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED. :param license_model: The license_model of this LaunchDbSystemFromBackupDetails. diff --git a/src/oci/database/models/patch.py b/src/oci/database/models/patch.py index c7a095e545..40565f7644 100644 --- a/src/oci/database/models/patch.py +++ b/src/oci/database/models/patch.py @@ -9,7 +9,7 @@ @init_model_state_from_kwargs class Patch(object): """ - A Patch for a DB System or DB Home. + A Patch for a DB system or DB Home. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, @@ -183,7 +183,9 @@ def description(self, description): def id(self): """ **[Required]** Gets the id of this Patch. - The OCID of the patch. + The `OCID`__ of the patch. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The id of this Patch. @@ -195,7 +197,9 @@ def id(self): def id(self, id): """ Sets the id of this Patch. - The OCID of the patch. + The `OCID`__ of the patch. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param id: The id of this Patch. diff --git a/src/oci/database/models/patch_details.py b/src/oci/database/models/patch_details.py index 95444f20f9..835df6d5eb 100644 --- a/src/oci/database/models/patch_details.py +++ b/src/oci/database/models/patch_details.py @@ -11,7 +11,7 @@ class PatchDetails(object): """ The details about what actions to perform and using what patch to the specified target. This is part of an update request that is applied to a version field on the target such - as DB System, database home, etc. + as DB system, database home, etc. """ #: A constant which can be used with the action property of a PatchDetails. @@ -86,7 +86,9 @@ def action(self, action): def patch_id(self): """ Gets the patch_id of this PatchDetails. - The OCID of the patch. + The `OCID`__ of the patch. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The patch_id of this PatchDetails. @@ -98,7 +100,9 @@ def patch_id(self): def patch_id(self, patch_id): """ Sets the patch_id of this PatchDetails. - The OCID of the patch. + The `OCID`__ of the patch. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param patch_id: The patch_id of this PatchDetails. diff --git a/src/oci/database/models/patch_history_entry.py b/src/oci/database/models/patch_history_entry.py index ab8e1f0981..231c432a18 100644 --- a/src/oci/database/models/patch_history_entry.py +++ b/src/oci/database/models/patch_history_entry.py @@ -132,7 +132,9 @@ def action(self, action): def id(self): """ **[Required]** Gets the id of this PatchHistoryEntry. - The OCID of the patch history entry. + The `OCID`__ of the patch history entry. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The id of this PatchHistoryEntry. @@ -144,7 +146,9 @@ def id(self): def id(self, id): """ Sets the id of this PatchHistoryEntry. - The OCID of the patch history entry. + The `OCID`__ of the patch history entry. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param id: The id of this PatchHistoryEntry. @@ -212,7 +216,9 @@ def lifecycle_state(self, lifecycle_state): def patch_id(self): """ **[Required]** Gets the patch_id of this PatchHistoryEntry. - The OCID of the patch. + The `OCID`__ of the patch. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The patch_id of this PatchHistoryEntry. @@ -224,7 +230,9 @@ def patch_id(self): def patch_id(self, patch_id): """ Sets the patch_id of this PatchHistoryEntry. - The OCID of the patch. + The `OCID`__ of the patch. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param patch_id: The patch_id of this PatchHistoryEntry. diff --git a/src/oci/database/models/patch_history_entry_summary.py b/src/oci/database/models/patch_history_entry_summary.py index 0cdf2065e1..1028db26e6 100644 --- a/src/oci/database/models/patch_history_entry_summary.py +++ b/src/oci/database/models/patch_history_entry_summary.py @@ -132,7 +132,9 @@ def action(self, action): def id(self): """ **[Required]** Gets the id of this PatchHistoryEntrySummary. - The OCID of the patch history entry. + The `OCID`__ of the patch history entry. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The id of this PatchHistoryEntrySummary. @@ -144,7 +146,9 @@ def id(self): def id(self, id): """ Sets the id of this PatchHistoryEntrySummary. - The OCID of the patch history entry. + The `OCID`__ of the patch history entry. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param id: The id of this PatchHistoryEntrySummary. @@ -212,7 +216,9 @@ def lifecycle_state(self, lifecycle_state): def patch_id(self): """ **[Required]** Gets the patch_id of this PatchHistoryEntrySummary. - The OCID of the patch. + The `OCID`__ of the patch. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The patch_id of this PatchHistoryEntrySummary. @@ -224,7 +230,9 @@ def patch_id(self): def patch_id(self, patch_id): """ Sets the patch_id of this PatchHistoryEntrySummary. - The OCID of the patch. + The `OCID`__ of the patch. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param patch_id: The patch_id of this PatchHistoryEntrySummary. diff --git a/src/oci/database/models/patch_summary.py b/src/oci/database/models/patch_summary.py index 9f44892bb4..d8e00fdb95 100644 --- a/src/oci/database/models/patch_summary.py +++ b/src/oci/database/models/patch_summary.py @@ -9,7 +9,7 @@ @init_model_state_from_kwargs class PatchSummary(object): """ - A Patch for a DB System or DB Home. + A Patch for a DB system or DB Home. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, @@ -183,7 +183,9 @@ def description(self, description): def id(self): """ **[Required]** Gets the id of this PatchSummary. - The OCID of the patch. + The `OCID`__ of the patch. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :return: The id of this PatchSummary. @@ -195,7 +197,9 @@ def id(self): def id(self, id): """ Sets the id of this PatchSummary. - The OCID of the patch. + The `OCID`__ of the patch. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm :param id: The id of this PatchSummary. diff --git a/src/oci/database/models/reinstate_data_guard_association_details.py b/src/oci/database/models/reinstate_data_guard_association_details.py index 5cf07c205c..32ec706a73 100644 --- a/src/oci/database/models/reinstate_data_guard_association_details.py +++ b/src/oci/database/models/reinstate_data_guard_association_details.py @@ -36,7 +36,7 @@ def __init__(self, **kwargs): def database_admin_password(self): """ **[Required]** Gets the database_admin_password of this ReinstateDataGuardAssociationDetails. - The DB System administrator password. + The DB system administrator password. :return: The database_admin_password of this ReinstateDataGuardAssociationDetails. @@ -48,7 +48,7 @@ def database_admin_password(self): def database_admin_password(self, database_admin_password): """ Sets the database_admin_password of this ReinstateDataGuardAssociationDetails. - The DB System administrator password. + The DB system administrator password. :param database_admin_password: The database_admin_password of this ReinstateDataGuardAssociationDetails. diff --git a/src/oci/database/models/switchover_data_guard_association_details.py b/src/oci/database/models/switchover_data_guard_association_details.py index 6fd6e49d31..a6a94af73a 100644 --- a/src/oci/database/models/switchover_data_guard_association_details.py +++ b/src/oci/database/models/switchover_data_guard_association_details.py @@ -36,7 +36,7 @@ def __init__(self, **kwargs): def database_admin_password(self): """ **[Required]** Gets the database_admin_password of this SwitchoverDataGuardAssociationDetails. - The DB System administrator password. + The DB system administrator password. :return: The database_admin_password of this SwitchoverDataGuardAssociationDetails. @@ -48,7 +48,7 @@ def database_admin_password(self): def database_admin_password(self, database_admin_password): """ Sets the database_admin_password of this SwitchoverDataGuardAssociationDetails. - The DB System administrator password. + The DB system administrator password. :param database_admin_password: The database_admin_password of this SwitchoverDataGuardAssociationDetails. diff --git a/src/oci/database/models/update_autonomous_data_warehouse_details.py b/src/oci/database/models/update_autonomous_data_warehouse_details.py index 29710f874a..e5f8ea40aa 100644 --- a/src/oci/database/models/update_autonomous_data_warehouse_details.py +++ b/src/oci/database/models/update_autonomous_data_warehouse_details.py @@ -10,6 +10,8 @@ class UpdateAutonomousDataWarehouseDetails(object): """ Details to update an Oracle Autonomous Data Warehouse. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. """ def __init__(self, **kwargs): @@ -95,7 +97,7 @@ def admin_password(self, admin_password): def cpu_core_count(self): """ Gets the cpu_core_count of this UpdateAutonomousDataWarehouseDetails. - The number of CPU Cores to be made available to the database. + The number of CPU cores to be made available to the database. :return: The cpu_core_count of this UpdateAutonomousDataWarehouseDetails. @@ -107,7 +109,7 @@ def cpu_core_count(self): def cpu_core_count(self, cpu_core_count): """ Sets the cpu_core_count of this UpdateAutonomousDataWarehouseDetails. - The number of CPU Cores to be made available to the database. + The number of CPU cores to be made available to the database. :param cpu_core_count: The cpu_core_count of this UpdateAutonomousDataWarehouseDetails. @@ -119,7 +121,7 @@ def cpu_core_count(self, cpu_core_count): def data_storage_size_in_tbs(self): """ Gets the data_storage_size_in_tbs of this UpdateAutonomousDataWarehouseDetails. - Size, in TBs, of the data volume that will be attached to the database. + Size, in terabytes, of the data volume that will be attached to the database. :return: The data_storage_size_in_tbs of this UpdateAutonomousDataWarehouseDetails. @@ -131,7 +133,7 @@ def data_storage_size_in_tbs(self): def data_storage_size_in_tbs(self, data_storage_size_in_tbs): """ Sets the data_storage_size_in_tbs of this UpdateAutonomousDataWarehouseDetails. - Size, in TBs, of the data volume that will be attached to the database. + Size, in terabytes, of the data volume that will be attached to the database. :param data_storage_size_in_tbs: The data_storage_size_in_tbs of this UpdateAutonomousDataWarehouseDetails. diff --git a/src/oci/database/models/update_autonomous_database_details.py b/src/oci/database/models/update_autonomous_database_details.py index 2e9960cc4e..238c24645c 100644 --- a/src/oci/database/models/update_autonomous_database_details.py +++ b/src/oci/database/models/update_autonomous_database_details.py @@ -10,6 +10,8 @@ class UpdateAutonomousDatabaseDetails(object): """ Details to update an Oracle Autonomous Database. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. """ def __init__(self, **kwargs): @@ -95,7 +97,7 @@ def admin_password(self, admin_password): def cpu_core_count(self): """ Gets the cpu_core_count of this UpdateAutonomousDatabaseDetails. - The number of CPU Cores to be made available to the database. + The number of CPU cores to be made available to the database. :return: The cpu_core_count of this UpdateAutonomousDatabaseDetails. @@ -107,7 +109,7 @@ def cpu_core_count(self): def cpu_core_count(self, cpu_core_count): """ Sets the cpu_core_count of this UpdateAutonomousDatabaseDetails. - The number of CPU Cores to be made available to the database. + The number of CPU cores to be made available to the database. :param cpu_core_count: The cpu_core_count of this UpdateAutonomousDatabaseDetails. @@ -119,7 +121,7 @@ def cpu_core_count(self, cpu_core_count): def data_storage_size_in_tbs(self): """ Gets the data_storage_size_in_tbs of this UpdateAutonomousDatabaseDetails. - Size, in TBs, of the data volume that will be attached to the database. + The size, in terabytes, of the data volume that will be attached to the database. :return: The data_storage_size_in_tbs of this UpdateAutonomousDatabaseDetails. @@ -131,7 +133,7 @@ def data_storage_size_in_tbs(self): def data_storage_size_in_tbs(self, data_storage_size_in_tbs): """ Sets the data_storage_size_in_tbs of this UpdateAutonomousDatabaseDetails. - Size, in TBs, of the data volume that will be attached to the database. + The size, in terabytes, of the data volume that will be attached to the database. :param data_storage_size_in_tbs: The data_storage_size_in_tbs of this UpdateAutonomousDatabaseDetails. diff --git a/src/oci/database/models/update_database_details.py b/src/oci/database/models/update_database_details.py index ee0a65545b..20c840d2e4 100644 --- a/src/oci/database/models/update_database_details.py +++ b/src/oci/database/models/update_database_details.py @@ -9,7 +9,9 @@ @init_model_state_from_kwargs class UpdateDatabaseDetails(object): """ - UpdateDatabaseDetails model. + Details to update a database. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. """ def __init__(self, **kwargs): diff --git a/src/oci/database/models/update_db_home_details.py b/src/oci/database/models/update_db_home_details.py index 7b884061d5..eeb7b27624 100644 --- a/src/oci/database/models/update_db_home_details.py +++ b/src/oci/database/models/update_db_home_details.py @@ -9,7 +9,7 @@ @init_model_state_from_kwargs class UpdateDbHomeDetails(object): """ - Describes the modification parameters for the DB Home. + Describes the modification parameters for the database home. """ def __init__(self, **kwargs): diff --git a/src/oci/database/models/update_db_system_details.py b/src/oci/database/models/update_db_system_details.py index b0f4916338..f587c5800a 100644 --- a/src/oci/database/models/update_db_system_details.py +++ b/src/oci/database/models/update_db_system_details.py @@ -9,7 +9,9 @@ @init_model_state_from_kwargs class UpdateDbSystemDetails(object): """ - Describes the modification parameters for the DB System. + Describes the parameters for updating the DB system. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. """ def __init__(self, **kwargs): @@ -71,7 +73,7 @@ def __init__(self, **kwargs): def cpu_core_count(self): """ Gets the cpu_core_count of this UpdateDbSystemDetails. - The number of CPU Cores to be set on the DB System. Applicable only for non-VM based DB systems. + The new number of CPU cores to set for the DB system. Not applicable for virtual machine DB systems. :return: The cpu_core_count of this UpdateDbSystemDetails. @@ -83,7 +85,7 @@ def cpu_core_count(self): def cpu_core_count(self, cpu_core_count): """ Sets the cpu_core_count of this UpdateDbSystemDetails. - The number of CPU Cores to be set on the DB System. Applicable only for non-VM based DB systems. + The new number of CPU cores to set for the DB system. Not applicable for virtual machine DB systems. :param cpu_core_count: The cpu_core_count of this UpdateDbSystemDetails. @@ -95,7 +97,7 @@ def cpu_core_count(self, cpu_core_count): def data_storage_size_in_gbs(self): """ Gets the data_storage_size_in_gbs of this UpdateDbSystemDetails. - Size, in GBs, to which the currently attached storage needs to be scaled up to for VM based DB system. This must be greater than current storage size. Note that the total storage size attached will be more than what is requested, to account for REDO/RECO space and software volume. + The size, in gigabytes, to scale the attached storage up to for this virtual machine DB system. This value must be greater than current storage size. Note that the resulting total storage size attached will be greater than the amount requested to allow for REDO/RECO space and software volume. Applies only to virtual machine DB systems. :return: The data_storage_size_in_gbs of this UpdateDbSystemDetails. @@ -107,7 +109,7 @@ def data_storage_size_in_gbs(self): def data_storage_size_in_gbs(self, data_storage_size_in_gbs): """ Sets the data_storage_size_in_gbs of this UpdateDbSystemDetails. - Size, in GBs, to which the currently attached storage needs to be scaled up to for VM based DB system. This must be greater than current storage size. Note that the total storage size attached will be more than what is requested, to account for REDO/RECO space and software volume. + The size, in gigabytes, to scale the attached storage up to for this virtual machine DB system. This value must be greater than current storage size. Note that the resulting total storage size attached will be greater than the amount requested to allow for REDO/RECO space and software volume. Applies only to virtual machine DB systems. :param data_storage_size_in_gbs: The data_storage_size_in_gbs of this UpdateDbSystemDetails. @@ -187,7 +189,7 @@ def freeform_tags(self, freeform_tags): def ssh_public_keys(self): """ Gets the ssh_public_keys of this UpdateDbSystemDetails. - The public key portion of the key pair to use for SSH access to the DB System. Multiple public keys can be provided. The length of the combined keys cannot exceed 10,000 characters. + The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 10,000 characters. :return: The ssh_public_keys of this UpdateDbSystemDetails. @@ -199,7 +201,7 @@ def ssh_public_keys(self): def ssh_public_keys(self, ssh_public_keys): """ Sets the ssh_public_keys of this UpdateDbSystemDetails. - The public key portion of the key pair to use for SSH access to the DB System. Multiple public keys can be provided. The length of the combined keys cannot exceed 10,000 characters. + The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 10,000 characters. :param ssh_public_keys: The ssh_public_keys of this UpdateDbSystemDetails. diff --git a/src/oci/version.py b/src/oci/version.py index c19f1822c6..20b15562b5 100644 --- a/src/oci/version.py +++ b/src/oci/version.py @@ -1,4 +1,4 @@ # coding: utf-8 # Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved. -__version__ = "2.0.2" +__version__ = "2.0.3" diff --git a/tests/integ/test_launch_instance_tutorial.py b/tests/integ/test_launch_instance_tutorial.py index 799c755a37..9d4e9356cb 100644 --- a/tests/integ/test_launch_instance_tutorial.py +++ b/tests/integ/test_launch_instance_tutorial.py @@ -13,8 +13,8 @@ def test_tutorial(virtual_network, compute, block_storage, config): test_id = tests.util.random_number_string() - print('Running Launching Your First Instance tutorial') - print('Objects will have ID ' + test_id) + # print('Running Launching Your First Instance tutorial') + # print('Objects will have ID ' + test_id) availability_domain = util.availability_domain() compartment = config["tenancy"] @@ -47,8 +47,8 @@ def test_tutorial(virtual_network, compute, block_storage, config): volume = create_volume(block_storage, compartment, test_id, availability_domain) attachment = attach_volume(compute, compartment, instance, volume) except Exception as e: - print('Exception during creation phase: ' + str(e)) - raise + # print('Exception during creation phase: ' + str(e)) + raise e finally: if volume: if attachment: @@ -63,7 +63,7 @@ def test_tutorial(virtual_network, compute, block_storage, config): def create_cloud_network(virtual_network, compartment, test_id): - print('Creating cloud network') + # print('Creating cloud network') request = oci.core.models.CreateVcnDetails() request.cidr_block = '10.0.0.0/16' request.display_name = 'pythonsdk_test_vcn_' + test_id @@ -82,7 +82,7 @@ def create_cloud_network(virtual_network, compartment, test_id): def delete_cloud_network(virtual_network, vcn): - print('Deleting vcn') + # print('Deleting vcn') response = virtual_network.delete_vcn(vcn.id) assert response.status == 204 @@ -99,7 +99,7 @@ def delete_cloud_network(virtual_network, vcn): def create_subnet(virtual_network, compartment, test_id, availability_domain, vcn): - print('Creating subnet') + # print('Creating subnet') request = oci.core.models.CreateSubnetDetails() request.cidr_block = '10.0.0.0/16' request.availability_domain = availability_domain @@ -123,7 +123,7 @@ def create_subnet(virtual_network, compartment, test_id, availability_domain, vc def delete_subnet(virtual_network, subnet): - print('Deleting subnet') + # print('Deleting subnet') response = virtual_network.delete_subnet(subnet.id) assert response.status == 204 @@ -139,7 +139,7 @@ def delete_subnet(virtual_network, subnet): def create_internet_gateway(virtual_network, compartment, test_id, vcn): - print('Creating internet gateway') + # print('Creating internet gateway') request = oci.core.models.CreateInternetGatewayDetails() request.display_name = 'pythonsdk_test_ig_' + test_id request.compartment_id = compartment @@ -162,7 +162,7 @@ def create_internet_gateway(virtual_network, compartment, test_id, vcn): def update_route_table(virtual_network, test_id, vcn, gateway): - print('Updating route table') + # print('Updating route table') route_rule = oci.core.models.RouteRule() route_rule.cidr_block = '0.0.0.0/0' route_rule.display_name = 'pythonsdk_route_rule_' + test_id @@ -181,7 +181,7 @@ def update_route_table(virtual_network, test_id, vcn, gateway): def launch_instance(compute, compartment, test_id, availability_domain, subnet, public_key): - print('Launching instance') + # print('Launching instance') request = oci.core.models.LaunchInstanceDetails() request.availability_domain = availability_domain @@ -211,7 +211,7 @@ def launch_instance(compute, compartment, test_id, availability_domain, subnet, def terminate_instance(compute, instance): - print('Terminating instance') + # print('Terminating instance') response = compute.terminate_instance(instance.id) assert response.status == 204 @@ -220,7 +220,7 @@ def terminate_instance(compute, instance): def create_volume(block_storage, compartment, test_id, availability_domain): - print('Creating volume') + # print('Creating volume') request = oci.core.models.CreateVolumeDetails() request.display_name = 'pythonsdk_volume_' + test_id request.compartment_id = compartment @@ -243,7 +243,7 @@ def create_volume(block_storage, compartment, test_id, availability_domain): def delete_volume(block_storage, volume): - print('Deleting volume') + # print('Deleting volume') response = block_storage.delete_volume(volume.id) assert response.status == 204 @@ -258,7 +258,7 @@ def delete_volume(block_storage, volume): def log_public_ip_address(compute, virtual_network, compartment, instance): - print('Getting public IP address') + # print('Getting public IP address') response = compute.list_vnic_attachments( compartment, instance_id=instance.id) assert response.status == 200 @@ -276,11 +276,11 @@ def log_public_ip_address(compute, virtual_network, compartment, instance): ) assert response.status == 200 assert response.data.public_ip is not None - print('Public IP Address: ' + response.data.public_ip) + # print('Public IP Address: ' + response.data.public_ip) def attach_volume(compute, compartment, instance, volume): - print('Attaching volume') + # print('Attaching volume') request = oci.core.models.AttachIScsiVolumeDetails() request.compartment_id = compartment request.instance_id = instance.id @@ -301,7 +301,7 @@ def attach_volume(compute, compartment, instance, volume): def detach_volume(compute, attachment): - print('Detaching volume') + # print('Detaching volume') response = compute.detach_volume(attachment.id) assert response.status == 204 diff --git a/tests/unit/test_basic_api_calls.py b/tests/unit/test_basic_api_calls.py index a25d86b6fa..0dde69ec57 100644 --- a/tests/unit/test_basic_api_calls.py +++ b/tests/unit/test_basic_api_calls.py @@ -43,19 +43,18 @@ def test_limit(identity, config): def test_api_call_with_explicit_timeout(config): client = oci.identity.IdentityClient(config) - client.base_client.timeout = 0.01 # 0.01s timeout on connection and read. Should be too short to connect without timing out - with pytest.raises(oci.exceptions.ConnectTimeout) as e: + # Test connection timeout + client.base_client.timeout = 0.01 # 0.01s timeout on connection and read. Should be too short to connect without timing out + with pytest.raises(oci.exceptions.ConnectTimeout): client.list_users(config['tenancy']) - assert isinstance(e, oci._vendor.requests.exceptions.ConnectTimeout) - assert 'connect timeout=0.01' in str(e) assert False - client.base_client.timeout = (0.05, 25) # 0.05s timeout on connection, 25s on read. Should be too short to connect without timing out - with pytest.raises(oci.exceptions.ConnectTimeout) as e: + # Test read timeout + client.base_client.timeout = (1, 0.01) # 1s timeout on connection, 0.01s on read. Should be too short read + with pytest.raises(oci.exceptions.RequestException): client.list_users(config['tenancy']) - assert isinstance(e, oci._vendor.requests.exceptions.ConnectTimeout) - assert 'connect timeout=0.05' in str(e) + assert False client.base_client.timeout = 5 response = client.list_users(config['tenancy']) diff --git a/tests/unit/test_waiters.py b/tests/unit/test_waiters.py index 8c55f16c9e..487a64b154 100644 --- a/tests/unit/test_waiters.py +++ b/tests/unit/test_waiters.py @@ -61,7 +61,7 @@ def test_invalid_operation(identity, config): # Create User request = oci.identity.models.CreateUserDetails() request.compartment_id = config["tenancy"] - request.name = tests.util.unique_name('python_wait_test_user') + request.name = tests.util.unique_name('python_wait_test_user', ignore_vcr=True) request.description = 'test user' response = identity.create_user(request) user_id = response.data.id @@ -84,7 +84,7 @@ def test_already_in_state(identity, config): description = 'test user' request = oci.identity.models.CreateUserDetails() request.compartment_id = config["tenancy"] - request.name = tests.util.unique_name('python_wait_test_user') + request.name = tests.util.unique_name('python_wait_test_user', ignore_vcr=True) request.description = description response = identity.create_user(request) user_id = response.data.id @@ -104,7 +104,7 @@ def test_wait_time_exceeded(identity, config): description = 'test user' request = oci.identity.models.CreateUserDetails() request.compartment_id = config["tenancy"] - request.name = tests.util.unique_name('python_wait_test_user') + request.name = tests.util.unique_name('python_wait_test_user', ignore_vcr=True) request.description = description response = identity.create_user(request) user_id = response.data.id @@ -137,7 +137,7 @@ def test_eval_function_lambda(identity, config): description = 'test user' request = oci.identity.models.CreateUserDetails() request.compartment_id = config["tenancy"] - request.name = tests.util.unique_name('python_wait_test_user') + request.name = tests.util.unique_name('python_wait_test_user', ignore_vcr=True) request.description = description response = identity.create_user(request) user_id = response.data.id @@ -161,7 +161,7 @@ def test_eval_function_func_ref(identity, config): description = 'test user' request = oci.identity.models.CreateUserDetails() request.compartment_id = config["tenancy"] - request.name = tests.util.unique_name('python_wait_test_user') + request.name = tests.util.unique_name('python_wait_test_user', ignore_vcr=True) request.description = description response = identity.create_user(request) user_id = response.data.id