diff --git a/CHANGELOG.rst b/CHANGELOG.rst index ebb8c08084..59b4e83b2c 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -3,6 +3,24 @@ Change Log All notable changes to this project will be documented in this file. The format is based on `Keep a Changelog `_. +==================== +2.29.0 - 2021-01-26 +==================== + +Added +----- +* Support for creating, managing, and using asymmetric keys in the Key Management service +* Support for peer ACD unique names in Exadata Cloud at Customer in the Database service +* Support for ACLs on autonomous databases in Exadata Cloud at Customer Data Guard in the Database service +* Support for drift detection on individual resources of a stack in the Resource Manager service +* Support for private access channels and vanity URLs in the Analytics Cloud service +* Support for updating load balancer shapes in the Blockchain Platform service +* Support for assigning volume backup policies to volume groups in the Block Volume service + +Breaking +-------- +* Parameter `idcs_access_token` in model `CreateBlockchainPlatformDetails` changed from optional to required in the Blockchain service + ==================== 2.28.0 - 2021-01-19 ==================== diff --git a/docs/api/analytics.rst b/docs/api/analytics.rst index 104829654e..b14420d666 100644 --- a/docs/api/analytics.rst +++ b/docs/api/analytics.rst @@ -24,11 +24,18 @@ Analytics oci.analytics.models.ChangeAnalyticsInstanceNetworkEndpointDetails oci.analytics.models.ChangeCompartmentDetails oci.analytics.models.CreateAnalyticsInstanceDetails + oci.analytics.models.CreatePrivateAccessChannelDetails + oci.analytics.models.CreateVanityUrlDetails oci.analytics.models.NetworkEndpointDetails + oci.analytics.models.PrivateAccessChannel oci.analytics.models.PrivateEndpointDetails + oci.analytics.models.PrivateSourceDnsZone oci.analytics.models.PublicEndpointDetails oci.analytics.models.ScaleAnalyticsInstanceDetails oci.analytics.models.UpdateAnalyticsInstanceDetails + oci.analytics.models.UpdatePrivateAccessChannelDetails + oci.analytics.models.UpdateVanityUrlDetails + oci.analytics.models.VanityUrlDetails oci.analytics.models.VirtualCloudNetwork oci.analytics.models.WorkRequest oci.analytics.models.WorkRequestError diff --git a/docs/api/analytics/models/oci.analytics.models.CreatePrivateAccessChannelDetails.rst b/docs/api/analytics/models/oci.analytics.models.CreatePrivateAccessChannelDetails.rst new file mode 100644 index 0000000000..40b48b22f9 --- /dev/null +++ b/docs/api/analytics/models/oci.analytics.models.CreatePrivateAccessChannelDetails.rst @@ -0,0 +1,11 @@ +CreatePrivateAccessChannelDetails +================================= + +.. currentmodule:: oci.analytics.models + +.. autoclass:: CreatePrivateAccessChannelDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/analytics/models/oci.analytics.models.CreateVanityUrlDetails.rst b/docs/api/analytics/models/oci.analytics.models.CreateVanityUrlDetails.rst new file mode 100644 index 0000000000..cbef23f276 --- /dev/null +++ b/docs/api/analytics/models/oci.analytics.models.CreateVanityUrlDetails.rst @@ -0,0 +1,11 @@ +CreateVanityUrlDetails +====================== + +.. currentmodule:: oci.analytics.models + +.. autoclass:: CreateVanityUrlDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/analytics/models/oci.analytics.models.PrivateAccessChannel.rst b/docs/api/analytics/models/oci.analytics.models.PrivateAccessChannel.rst new file mode 100644 index 0000000000..66c2fdd617 --- /dev/null +++ b/docs/api/analytics/models/oci.analytics.models.PrivateAccessChannel.rst @@ -0,0 +1,11 @@ +PrivateAccessChannel +==================== + +.. currentmodule:: oci.analytics.models + +.. autoclass:: PrivateAccessChannel + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/analytics/models/oci.analytics.models.PrivateSourceDnsZone.rst b/docs/api/analytics/models/oci.analytics.models.PrivateSourceDnsZone.rst new file mode 100644 index 0000000000..22c2bdf5e4 --- /dev/null +++ b/docs/api/analytics/models/oci.analytics.models.PrivateSourceDnsZone.rst @@ -0,0 +1,11 @@ +PrivateSourceDnsZone +==================== + +.. currentmodule:: oci.analytics.models + +.. autoclass:: PrivateSourceDnsZone + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/analytics/models/oci.analytics.models.UpdatePrivateAccessChannelDetails.rst b/docs/api/analytics/models/oci.analytics.models.UpdatePrivateAccessChannelDetails.rst new file mode 100644 index 0000000000..d539732369 --- /dev/null +++ b/docs/api/analytics/models/oci.analytics.models.UpdatePrivateAccessChannelDetails.rst @@ -0,0 +1,11 @@ +UpdatePrivateAccessChannelDetails +================================= + +.. currentmodule:: oci.analytics.models + +.. autoclass:: UpdatePrivateAccessChannelDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/analytics/models/oci.analytics.models.UpdateVanityUrlDetails.rst b/docs/api/analytics/models/oci.analytics.models.UpdateVanityUrlDetails.rst new file mode 100644 index 0000000000..5ee39030c6 --- /dev/null +++ b/docs/api/analytics/models/oci.analytics.models.UpdateVanityUrlDetails.rst @@ -0,0 +1,11 @@ +UpdateVanityUrlDetails +====================== + +.. currentmodule:: oci.analytics.models + +.. autoclass:: UpdateVanityUrlDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/analytics/models/oci.analytics.models.VanityUrlDetails.rst b/docs/api/analytics/models/oci.analytics.models.VanityUrlDetails.rst new file mode 100644 index 0000000000..69d3d6fe60 --- /dev/null +++ b/docs/api/analytics/models/oci.analytics.models.VanityUrlDetails.rst @@ -0,0 +1,11 @@ +VanityUrlDetails +================ + +.. currentmodule:: oci.analytics.models + +.. autoclass:: VanityUrlDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/key_management.rst b/docs/api/key_management.rst index 886e9dc8cd..bc0fe36b4e 100644 --- a/docs/api/key_management.rst +++ b/docs/api/key_management.rst @@ -51,10 +51,14 @@ Key Management oci.key_management.models.ScheduleKeyDeletionDetails oci.key_management.models.ScheduleKeyVersionDeletionDetails oci.key_management.models.ScheduleVaultDeletionDetails + oci.key_management.models.SignDataDetails + oci.key_management.models.SignedData oci.key_management.models.UpdateKeyDetails oci.key_management.models.UpdateVaultDetails oci.key_management.models.Vault oci.key_management.models.VaultSummary oci.key_management.models.VaultUsage + oci.key_management.models.VerifiedData + oci.key_management.models.VerifyDataDetails oci.key_management.models.WrappedImportKey oci.key_management.models.WrappingKey diff --git a/docs/api/key_management/models/oci.key_management.models.SignDataDetails.rst b/docs/api/key_management/models/oci.key_management.models.SignDataDetails.rst new file mode 100644 index 0000000000..17d65313d6 --- /dev/null +++ b/docs/api/key_management/models/oci.key_management.models.SignDataDetails.rst @@ -0,0 +1,11 @@ +SignDataDetails +=============== + +.. currentmodule:: oci.key_management.models + +.. autoclass:: SignDataDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/key_management/models/oci.key_management.models.SignedData.rst b/docs/api/key_management/models/oci.key_management.models.SignedData.rst new file mode 100644 index 0000000000..4499ff95c9 --- /dev/null +++ b/docs/api/key_management/models/oci.key_management.models.SignedData.rst @@ -0,0 +1,11 @@ +SignedData +========== + +.. currentmodule:: oci.key_management.models + +.. autoclass:: SignedData + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/key_management/models/oci.key_management.models.VerifiedData.rst b/docs/api/key_management/models/oci.key_management.models.VerifiedData.rst new file mode 100644 index 0000000000..385eb3a7e5 --- /dev/null +++ b/docs/api/key_management/models/oci.key_management.models.VerifiedData.rst @@ -0,0 +1,11 @@ +VerifiedData +============ + +.. currentmodule:: oci.key_management.models + +.. autoclass:: VerifiedData + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/key_management/models/oci.key_management.models.VerifyDataDetails.rst b/docs/api/key_management/models/oci.key_management.models.VerifyDataDetails.rst new file mode 100644 index 0000000000..aa8f932a76 --- /dev/null +++ b/docs/api/key_management/models/oci.key_management.models.VerifyDataDetails.rst @@ -0,0 +1,11 @@ +VerifyDataDetails +================= + +.. currentmodule:: oci.key_management.models + +.. autoclass:: VerifyDataDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/resource_manager.rst b/docs/api/resource_manager.rst index 886d62befa..d6e79015db 100644 --- a/docs/api/resource_manager.rst +++ b/docs/api/resource_manager.rst @@ -45,6 +45,7 @@ Resource Manager oci.resource_manager.models.CreateZipUploadConfigSourceDetails oci.resource_manager.models.DestroyJobOperationDetails oci.resource_manager.models.DestroyJobOperationDetailsSummary + oci.resource_manager.models.DetectStackDriftDetails oci.resource_manager.models.FailureDetails oci.resource_manager.models.GitConfigSource oci.resource_manager.models.GitConfigSourceRecord diff --git a/docs/api/resource_manager/models/oci.resource_manager.models.DetectStackDriftDetails.rst b/docs/api/resource_manager/models/oci.resource_manager.models.DetectStackDriftDetails.rst new file mode 100644 index 0000000000..3069a5a56a --- /dev/null +++ b/docs/api/resource_manager/models/oci.resource_manager.models.DetectStackDriftDetails.rst @@ -0,0 +1,11 @@ +DetectStackDriftDetails +======================= + +.. currentmodule:: oci.resource_manager.models + +.. autoclass:: DetectStackDriftDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/examples/showoci/CHANGELOG.rst b/examples/showoci/CHANGELOG.rst index af43eda3d2..766bbeea8d 100755 --- a/examples/showoci/CHANGELOG.rst +++ b/examples/showoci/CHANGELOG.rst @@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file. The format is based on `Keep a Changelog `_. +===================== +21.01.21 - 21.01.21 +===================== +* Added SGW transit route +* Added LPG CIDR Blocks +* Added DRG Attachments + ===================== 21.01.07 - 21.01.07 ===================== diff --git a/examples/showoci/showoci.py b/examples/showoci/showoci.py index 87d8d7ab7f..a0f0881de7 100755 --- a/examples/showoci/showoci.py +++ b/examples/showoci/showoci.py @@ -92,7 +92,7 @@ import argparse import datetime -version = "21.01.07" +version = "21.01.21" ########################################################################## # check OCI version diff --git a/examples/showoci/showoci_data.py b/examples/showoci/showoci_data.py index 7b53d7fc0e..f5c0fa8aed 100755 --- a/examples/showoci/showoci_data.py +++ b/examples/showoci/showoci_data.py @@ -424,10 +424,24 @@ def __get_core_network_vcn_sgw(self, vcn_id): list_service_gateways = self.service.search_multi_items(self.service.C_NETWORK, self.service.C_NETWORK_SGW, 'vcn_id', vcn_id) for arr in list_service_gateways: - value = {'id': arr['id'], 'name': arr['name'], 'services': arr['services'], + value = {'id': arr['id'], + 'name': arr['name'], + 'services': arr['services'], 'compartment_name': arr['compartment_name'], 'compartment_id': arr['compartment_id'], - 'time_created': arr['time_created'], 'defined_tags': arr['defined_tags'], 'freeform_tags': arr['freeform_tags']} + 'route_table_id': arr['route_table_id'], + 'route_table': "", + 'transit': "", + 'time_created': arr['time_created'], + 'defined_tags': arr['defined_tags'], + 'freeform_tags': arr['freeform_tags']} + + # check route table + if value['route_table_id'] != "None": + route_table = self.__get_core_network_route(value['route_table_id']) + value['route_table'] = route_table + value['transit'] = " + Transit Route(" + route_table + ")" + data.append(value) return data @@ -442,6 +456,7 @@ def __get_core_network_vcn_sgw(self, vcn_id): def __get_core_network_vcn_drg_details(self, drg_attachment): retStr = "" name = "" + route_table = "" try: drg_id = drg_attachment['drg_id'] @@ -456,16 +471,22 @@ def __get_core_network_vcn_drg_details(self, drg_attachment): if len(list_ip_sec_connections) > 0: retStr += " + IPSEC (" + str(len(list_ip_sec_connections)) + ")" + # check if Virtual Circuits + list_virtual_circuits = self.service.search_multi_items(self.service.C_NETWORK, self.service.C_NETWORK_VC, 'drg_id', drg_id) + if len(list_virtual_circuits) > 0: + retStr += " + Fastconnect (" + str(len(list_virtual_circuits)) + ")" + # Check Remote Peering rpcs = self.service.search_multi_items(self.service.C_NETWORK, self.service.C_NETWORK_RPC, 'drg_id', drg_id) if len(rpcs) > 0: retStr += " + Remote Peering (" + str(len(rpcs)) + ")" # check transit routing - if drg_attachment['route_table_id'] != "None": - retStr += " + Transit Route(" + str(self.__get_core_network_route(drg_attachment['route_table_id']) + ")") + if drg_attachment['route_table_id'] != "None" and drg_attachment['route_table_id'] != "": + route_table = str(self.__get_core_network_route(drg_attachment['route_table_id'])) + retStr += " + Transit Route(" + route_table + ")" - return retStr, name + return retStr, name, route_table except Exception as e: self.__print_error("__get_core_network_vcn_drg_details", e) @@ -481,10 +502,11 @@ def __get_core_network_vcn_drg_attached(self, vcn_id): list_drg_attachments = self.service.search_multi_items(self.service.C_NETWORK, self.service.C_NETWORK_DRG_AT, 'vcn_id', vcn_id) for da in list_drg_attachments: - val, display_name = self.__get_core_network_vcn_drg_details(da) + val, display_name, route_table = self.__get_core_network_vcn_drg_details(da) value = {'id': da['id'], 'drg_id': da['drg_id'], 'route_table_id': da['route_table_id'], + 'route_table': route_table, 'display_name': display_name, 'name': val, 'compartment_name': da['compartment_name'], @@ -506,8 +528,10 @@ def __get_core_network_vcn_local_peering(self, vcn_id): local_peering_gateways = self.service.search_multi_items(self.service.C_NETWORK, self.service.C_NETWORK_LPG, 'vcn_id', vcn_id) for lpg in local_peering_gateways: routestr = "" + route_table = "" if lpg['route_table_id'] != "None": - routestr = " + Transit Route(" + str(self.__get_core_network_route(lpg['route_table_id'])) + ")" + route_table = str(self.__get_core_network_route(lpg['route_table_id'])) + routestr = " + Transit Route(" + route_table + ")" value = {'id': lpg['id'], 'name': (lpg['name'] + routestr), @@ -516,7 +540,8 @@ def __get_core_network_vcn_local_peering(self, vcn_id): 'compartment_name': lpg['compartment_name'], 'time_created': lpg['time_created'], 'route_table_id': lpg['route_table_id'], - 'route_table_name': routestr, + 'route_table_name': route_table, + 'route_table': routestr, 'vcn_id': lpg['vcn_id'], 'peering_status': lpg['peering_status'], 'peer_advertised_cidr': lpg['peer_advertised_cidr'], @@ -931,7 +956,29 @@ def __get_core_network_drg(self, region_name, compartment): data = [] try: drgs = self.service.search_multi_items(self.service.C_NETWORK, self.service.C_NETWORK_DRG, 'region_name', region_name, 'compartment_id', compartment['id']) - return drgs + for drg in drgs: + drg_id = drg['id'] + val = {'id': drg['id'], + 'name': drg['name'], + 'time_created': drg['time_created'], + 'redundancy': drg['redundancy'], + 'compartment_name': drg['compartment_name'], + 'compartment_id': drg['compartment_id'], + 'defined_tags': drg['defined_tags'], + 'freeform_tags': drg['freeform_tags'], + 'region_name': drg['region_name'], + 'ip_sec_connections': self.service.search_multi_items(self.service.C_NETWORK, self.service.C_NETWORK_IPS, 'drg_id', drg_id), + 'virtual_circuits': self.service.search_multi_items(self.service.C_NETWORK, self.service.C_NETWORK_VC, 'drg_id', drg_id), + 'remote_peerings': self.service.search_multi_items(self.service.C_NETWORK, self.service.C_NETWORK_RPC, 'drg_id', drg_id), + 'vcns': [] + } + + # Add VCNs + drg_attachments = self.service.search_multi_items(self.service.C_NETWORK, self.service.C_NETWORK_DRG_AT, 'drg_id', drg_id) + for da in drg_attachments: + val['vcns'].append(self.service.search_unique_item(self.service.C_NETWORK, self.service.C_NETWORK_VCN, 'id', da['vcn_id'])) + data.append(val) + return data except Exception as e: self.__print_error("__get_core_network_drg", e) diff --git a/examples/showoci/showoci_output.py b/examples/showoci/showoci_output.py index bdb0aabdd4..6da6baf0ee 100755 --- a/examples/showoci/showoci_output.py +++ b/examples/showoci/showoci_output.py @@ -530,7 +530,7 @@ def __print_core_network_vcn(self, vcns): if 'sgw' in vcn['data']: for sgwloop in vcn['data']['sgw']: - print(self.tabs + "Service GW : " + sgwloop['name'] + " - " + sgwloop['services'] + self.__print_core_network_vcn_compartment(vcn_compartment, sgwloop['compartment_name'])) + print(self.tabs + "Service GW : " + sgwloop['name'] + sgwloop['transit'] + " - " + sgwloop['services'] + self.__print_core_network_vcn_compartment(vcn_compartment, sgwloop['compartment_name'])) if 'nat' in vcn['data']: for natloop in vcn['data']['nat']: @@ -578,7 +578,16 @@ def __print_core_network_drg(self, drgs): self.print_header("DRGs", 2) for drg in drgs: - print(self.taba + "DRG " + drg['name'] + ", Redundant: " + drg['redundancy']) + print(self.taba + "DRG Name : " + drg['name'] + ", Redundant: " + drg['redundancy']) + if drg['ip_sec_connections']: + print(self.tabs + " IPSECs : " + str(', '.join(x['name'] + " (" + x['tunnels_status'] + ")" for x in drg['ip_sec_connections']))) + if drg['virtual_circuits']: + print(self.tabs + " VCs : " + str(', '.join(x['name'] + " (" + x['bgp_session_state'] + ")" for x in drg['virtual_circuits']))) + if drg['remote_peerings']: + print(self.tabs + " RPCs : " + str(', '.join(x['name'] + " (" + x['peering_status'] + ")" for x in drg['remote_peerings']))) + if drg['vcns']: + print(self.tabs + " VCNs : " + str(', '.join(x['name'] for x in drg['vcns']))) + print("") except Exception as e: self.__print_error("__print_core_network_vcn", e) @@ -594,7 +603,7 @@ def __print_core_network_remote_peering(self, rpcs): self.print_header("Remote Peering", 2) for rpc in rpcs: - print(self.tabs + "RPC Name : " + rpc['name']) + print(self.taba + "RPC Name : " + rpc['name']) print(self.tabs + " DRG : " + rpc['drg']) # if peer has name if not id diff --git a/examples/showoci/showoci_service.py b/examples/showoci/showoci_service.py index 7ec2ac8ff9..90c4b609dc 100755 --- a/examples/showoci/showoci_service.py +++ b/examples/showoci/showoci_service.py @@ -700,7 +700,7 @@ def search_multi_items(self, module, section, p1, v1, p2=None, v2=None, p3=None, return [e for e in array if e[p1] == v1] except Exception as e: - self.__print_error("search_multi_items", e) + self.__print_error("search_multi_items " + module + ":" + section, e) ########################################################################## # initialize data key if not exist @@ -1945,7 +1945,7 @@ def __load_core_network_vcn(self, virtual_network, compartments): # loop on the array # vcn = oci.core.models.Vcn() for vcn in vcns: - val = {'id': str(vcn.id), 'name': str(', '.join(x for x in vcn.cidr_blocks)) + " - " + str(vcn.display_name) + " - " + str(vcn.vcn_domain_name) + " - Main: " + str(vcn.cidr_block), + val = {'id': str(vcn.id), 'name': str(', '.join(x for x in vcn.cidr_blocks)) + " - " + str(vcn.display_name) + " - " + str(vcn.vcn_domain_name), 'display_name': str(vcn.display_name), 'cidr_block': str(vcn.cidr_block), 'cidr_blocks': vcn.cidr_blocks, @@ -2133,6 +2133,7 @@ def __load_core_network_lpg(self, virtual_network, compartments): # get the cidr block of the peering cidr = "" if lpg.peer_advertised_cidr is None else " - " + str(lpg.peer_advertised_cidr) + cidr += "" if not lpg.peer_advertised_cidr_details else " (" + str(', '.join(x for x in lpg.peer_advertised_cidr_details)) + ")" # add lpg info to data val = {'id': str(lpg.id), @@ -2974,10 +2975,14 @@ def __load_core_network_sgw(self, virtual_network, compartments): # loop on all sgws # sgw = oci.core.models.ServiceGateway for sgw in sgws: - val = {'id': str(sgw.id), 'vcn_id': str(sgw.vcn_id), 'name': str(sgw.display_name), + val = {'id': str(sgw.id), + 'vcn_id': str(sgw.vcn_id), + 'name': str(sgw.display_name), 'time_created': str(sgw.time_created), + 'route_table_id': str(sgw.route_table_id), 'services': str(', '.join(x.service_name for x in sgw.services)), - 'compartment_name': str(compartment['name']), 'compartment_id': str(compartment['id']), + 'compartment_name': str(compartment['name']), + 'compartment_id': str(compartment['id']), 'defined_tags': [] if sgw.defined_tags is None else sgw.defined_tags, 'freeform_tags': [] if sgw.freeform_tags is None else sgw.freeform_tags, 'region_name': str(self.config['region'])} @@ -3488,6 +3493,7 @@ def __load_core_network_ips(self, virtual_network, compartments): data_tun = [] try: tunnels = virtual_network.list_ip_sec_connection_tunnels(arr.id).data + tunnels_status = "" for tunnel in tunnels: tun_val = {'id': str(tunnel.id), 'status': str(tunnel.status), @@ -3498,6 +3504,9 @@ def __load_core_network_ips(self, virtual_network, compartments): 'cpe_ip': str(tunnel.cpe_ip), 'vpn_ip': str(tunnel.vpn_ip), 'bgp_info': ""} + if tunnels_status: + tunnels_status += " " + tunnels_status += str(tunnel.status) if tunnel.bgp_session_info: bs = tunnel.bgp_session_info @@ -3507,7 +3516,10 @@ def __load_core_network_ips(self, virtual_network, compartments): except Exception: pass - val = {'id': str(arr.id), 'name': str(arr.display_name), 'drg_id': str(arr.drg_id), + val = {'id': str(arr.id), + 'name': str(arr.display_name), + 'drg_id': str(arr.drg_id), + 'tunnels_status': tunnels_status, 'cpe_id': str(arr.cpe_id), 'time_created': str(arr.time_created), 'compartment_name': str(compartment['name']), 'compartment_id': str(compartment['id']), 'defined_tags': [] if arr.defined_tags is None else arr.defined_tags, diff --git a/src/oci/analytics/analytics_client.py b/src/oci/analytics/analytics_client.py index 738d250d47..ec3a1de24f 100644 --- a/src/oci/analytics/analytics_client.py +++ b/src/oci/analytics/analytics_client.py @@ -359,15 +359,388 @@ def create_analytics_instance(self, create_analytics_instance_details, **kwargs) body=create_analytics_instance_details, response_type="AnalyticsInstance") + def create_private_access_channel(self, analytics_instance_id, create_private_access_channel_details, **kwargs): + """ + Create an Private access Channel for the Analytics instance. The operation is long-running + and creates a new WorkRequest. + + + :param str analytics_instance_id: (required) + The OCID of the AnalyticsInstance. + + :param oci.analytics.models.CreatePrivateAccessChannelDetails create_private_access_channel_details: (required) + Input payload for creating a private access channel for an Analytics instance. + + :param str opc_request_id: (optional) + Unique identifier for the request. + If you need to contact Oracle about a particular request, please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + may be rejected). + + :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. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_private_access_channel API. + """ + resource_path = "/analyticsInstances/{analyticsInstanceId}/privateAccessChannels" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_private_access_channel got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "analyticsInstanceId": analytics_instance_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_private_access_channel_details) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_private_access_channel_details) + + def create_vanity_url(self, analytics_instance_id, create_vanity_url_details, **kwargs): + """ + Allows specifying a custom host name to be used to access the analytics instance. This requires prior setup of DNS entry and certificate + for this host. + + + :param str analytics_instance_id: (required) + The OCID of the AnalyticsInstance. + + :param oci.analytics.models.CreateVanityUrlDetails create_vanity_url_details: (required) + Vanity url details. + + :param str opc_request_id: (optional) + Unique identifier for the request. + If you need to contact Oracle about a particular request, please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + may be rejected). + + :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. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_vanity_url API. + """ + resource_path = "/analyticsInstances/{analyticsInstanceId}/vanityUrls" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_vanity_url got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "analyticsInstanceId": analytics_instance_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_vanity_url_details) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_vanity_url_details) + def delete_analytics_instance(self, analytics_instance_id, **kwargs): """ - Terminates the specified Analytics instance. The operation is long-running - and creates a new WorkRequest. + Terminates the specified Analytics instance. The operation is long-running + and creates a new WorkRequest. + + + :param str analytics_instance_id: (required) + The OCID of the AnalyticsInstance. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` + parameter to the value of the etag from a previous GET or POST response for that resource. The resource + will be updated or deleted only if the etag you provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + Unique identifier for the request. + If you need to contact Oracle about a particular request, please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + may be rejected). + + :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. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use delete_analytics_instance API. + """ + resource_path = "/analyticsInstances/{analyticsInstanceId}" + method = "DELETE" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "if_match", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "delete_analytics_instance got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "analyticsInstanceId": analytics_instance_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params) + + def delete_private_access_channel(self, private_access_channel_key, analytics_instance_id, **kwargs): + """ + Delete an Analytics instance's Private access channel with the given unique identifier key. + + + :param str private_access_channel_key: (required) + The unique identifier key of the Private Access Channel. + + :param str analytics_instance_id: (required) + The OCID of the AnalyticsInstance. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` + parameter to the value of the etag from a previous GET or POST response for that resource. The resource + will be updated or deleted only if the etag you provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + Unique identifier for the request. + If you need to contact Oracle about a particular request, please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + may be rejected). + + :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. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use delete_private_access_channel API. + """ + resource_path = "/analyticsInstances/{analyticsInstanceId}/privateAccessChannels/{privateAccessChannelKey}" + method = "DELETE" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "if_match", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "delete_private_access_channel got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "privateAccessChannelKey": private_access_channel_key, + "analyticsInstanceId": analytics_instance_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params) + + def delete_vanity_url(self, analytics_instance_id, vanity_url_key, **kwargs): + """ + Allows deleting a previously created vanity url. :param str analytics_instance_id: (required) The OCID of the AnalyticsInstance. + :param str vanity_url_key: (required) + Specify unique identifier key of a vanity url to update or delete. + :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource @@ -396,9 +769,9 @@ def delete_analytics_instance(self, analytics_instance_id, **kwargs): :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use delete_analytics_instance API. + Click `here `__ to see an example of how to use delete_vanity_url API. """ - resource_path = "/analyticsInstances/{analyticsInstanceId}" + resource_path = "/analyticsInstances/{analyticsInstanceId}/vanityUrls/{vanityUrlKey}" method = "DELETE" # Don't accept unknown kwargs @@ -411,10 +784,11 @@ def delete_analytics_instance(self, analytics_instance_id, **kwargs): extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "delete_analytics_instance got unknown kwargs: {!r}".format(extra_kwargs)) + "delete_vanity_url got unknown kwargs: {!r}".format(extra_kwargs)) path_params = { - "analyticsInstanceId": analytics_instance_id + "analyticsInstanceId": analytics_instance_id, + "vanityUrlKey": vanity_url_key } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -609,6 +983,86 @@ def get_analytics_instance(self, analytics_instance_id, **kwargs): header_params=header_params, response_type="AnalyticsInstance") + def get_private_access_channel(self, private_access_channel_key, analytics_instance_id, **kwargs): + """ + Retrieve private access channel in the specified Analytics Instance. + + + :param str private_access_channel_key: (required) + The unique identifier key of the Private Access Channel. + + :param str analytics_instance_id: (required) + The OCID of the AnalyticsInstance. + + :param str opc_request_id: (optional) + Unique identifier for the request. + If you need to contact Oracle about a particular request, please provide the request ID. + + :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. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.analytics.models.PrivateAccessChannel` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_private_access_channel API. + """ + resource_path = "/analyticsInstances/{analyticsInstanceId}/privateAccessChannels/{privateAccessChannelKey}" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_private_access_channel got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "privateAccessChannelKey": private_access_channel_key, + "analyticsInstanceId": analytics_instance_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="PrivateAccessChannel") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="PrivateAccessChannel") + def get_work_request(self, work_request_id, **kwargs): """ Get the details of a work request. @@ -1071,7 +1525,7 @@ def list_work_requests(self, compartment_id, **kwargs): The OCID of the resource associated with a work request. :param str resource_type: (optional) - Type of the resource associated with a work request + Type of the resource associated with a work request. Allowed values are: "ANALYTICS_INSTANCE" @@ -1585,3 +2039,205 @@ def update_analytics_instance(self, analytics_instance_id, update_analytics_inst header_params=header_params, body=update_analytics_instance_details, response_type="AnalyticsInstance") + + def update_private_access_channel(self, private_access_channel_key, analytics_instance_id, update_private_access_channel_details, **kwargs): + """ + Update the Private Access Channel with the given unique identifier key in the specified Analytics Instance. + + + :param str private_access_channel_key: (required) + The unique identifier key of the Private Access Channel. + + :param str analytics_instance_id: (required) + The OCID of the AnalyticsInstance. + + :param oci.analytics.models.UpdatePrivateAccessChannelDetails update_private_access_channel_details: (required) + Update the Private Access Channel with the given unique identifier key in the specified Analytics Instance. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` + parameter to the value of the etag from a previous GET or POST response for that resource. The resource + will be updated or deleted only if the etag you provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + Unique identifier for the request. + If you need to contact Oracle about a particular request, please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + may be rejected). + + :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. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_private_access_channel API. + """ + resource_path = "/analyticsInstances/{analyticsInstanceId}/privateAccessChannels/{privateAccessChannelKey}" + method = "PUT" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "if_match", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "update_private_access_channel got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "privateAccessChannelKey": private_access_channel_key, + "analyticsInstanceId": analytics_instance_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_private_access_channel_details) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_private_access_channel_details) + + def update_vanity_url(self, analytics_instance_id, vanity_url_key, update_vanity_url_details, **kwargs): + """ + Allows uploading a new certificate for a vanity url, which will have to be done when the current certificate is expiring. + + + :param str analytics_instance_id: (required) + The OCID of the AnalyticsInstance. + + :param str vanity_url_key: (required) + Specify unique identifier key of a vanity url to update or delete. + + :param oci.analytics.models.UpdateVanityUrlDetails update_vanity_url_details: (required) + Vanity url details to update (certificate). + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` + parameter to the value of the etag from a previous GET or POST response for that resource. The resource + will be updated or deleted only if the etag you provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + Unique identifier for the request. + If you need to contact Oracle about a particular request, please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + may be rejected). + + :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. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_vanity_url API. + """ + resource_path = "/analyticsInstances/{analyticsInstanceId}/vanityUrls/{vanityUrlKey}" + method = "PUT" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "if_match", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "update_vanity_url got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "analyticsInstanceId": analytics_instance_id, + "vanityUrlKey": vanity_url_key + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_vanity_url_details) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_vanity_url_details) diff --git a/src/oci/analytics/analytics_client_composite_operations.py b/src/oci/analytics/analytics_client_composite_operations.py index 7d4ac30a3e..ca87a1a64f 100644 --- a/src/oci/analytics/analytics_client_composite_operations.py +++ b/src/oci/analytics/analytics_client_composite_operations.py @@ -143,6 +143,88 @@ def create_analytics_instance_and_wait_for_state(self, create_analytics_instance except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def create_private_access_channel_and_wait_for_state(self, analytics_instance_id, create_private_access_channel_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.analytics.AnalyticsClient.create_private_access_channel` and waits for the :py:class:`~oci.analytics.models.WorkRequest` + to enter the given state(s). + + :param str analytics_instance_id: (required) + The OCID of the AnalyticsInstance. + + :param oci.analytics.models.CreatePrivateAccessChannelDetails create_private_access_channel_details: (required) + Input payload for creating a private access channel for an Analytics instance. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.analytics.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.analytics.AnalyticsClient.create_private_access_channel` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.create_private_access_channel(analytics_instance_id, create_private_access_channel_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def create_vanity_url_and_wait_for_state(self, analytics_instance_id, create_vanity_url_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.analytics.AnalyticsClient.create_vanity_url` and waits for the :py:class:`~oci.analytics.models.WorkRequest` + to enter the given state(s). + + :param str analytics_instance_id: (required) + The OCID of the AnalyticsInstance. + + :param oci.analytics.models.CreateVanityUrlDetails create_vanity_url_details: (required) + Vanity url details. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.analytics.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.analytics.AnalyticsClient.create_vanity_url` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.create_vanity_url(analytics_instance_id, create_vanity_url_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def delete_analytics_instance_and_wait_for_state(self, analytics_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.analytics.AnalyticsClient.delete_analytics_instance` and waits for the :py:class:`~oci.analytics.models.WorkRequest` @@ -189,6 +271,104 @@ def delete_analytics_instance_and_wait_for_state(self, analytics_instance_id, wa except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def delete_private_access_channel_and_wait_for_state(self, private_access_channel_key, analytics_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.analytics.AnalyticsClient.delete_private_access_channel` and waits for the :py:class:`~oci.analytics.models.WorkRequest` + to enter the given state(s). + + :param str private_access_channel_key: (required) + The unique identifier key of the Private Access Channel. + + :param str analytics_instance_id: (required) + The OCID of the AnalyticsInstance. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.analytics.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.analytics.AnalyticsClient.delete_private_access_channel` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = None + try: + operation_result = self.client.delete_private_access_channel(private_access_channel_key, analytics_instance_id, **operation_kwargs) + except oci.exceptions.ServiceError as e: + if e.status == 404: + return WAIT_RESOURCE_NOT_FOUND + else: + raise e + + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def delete_vanity_url_and_wait_for_state(self, analytics_instance_id, vanity_url_key, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.analytics.AnalyticsClient.delete_vanity_url` and waits for the :py:class:`~oci.analytics.models.WorkRequest` + to enter the given state(s). + + :param str analytics_instance_id: (required) + The OCID of the AnalyticsInstance. + + :param str vanity_url_key: (required) + Specify unique identifier key of a vanity url to update or delete. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.analytics.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.analytics.AnalyticsClient.delete_vanity_url` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = None + try: + operation_result = self.client.delete_vanity_url(analytics_instance_id, vanity_url_key, **operation_kwargs) + except oci.exceptions.ServiceError as e: + if e.status == 404: + return WAIT_RESOURCE_NOT_FOUND + else: + raise e + + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def scale_analytics_instance_and_wait_for_state(self, analytics_instance_id, scale_analytics_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.analytics.AnalyticsClient.scale_analytics_instance` and waits for the :py:class:`~oci.analytics.models.WorkRequest` @@ -347,3 +527,91 @@ def update_analytics_instance_and_wait_for_state(self, analytics_instance_id, up return result_to_return except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def update_private_access_channel_and_wait_for_state(self, private_access_channel_key, analytics_instance_id, update_private_access_channel_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.analytics.AnalyticsClient.update_private_access_channel` and waits for the :py:class:`~oci.analytics.models.WorkRequest` + to enter the given state(s). + + :param str private_access_channel_key: (required) + The unique identifier key of the Private Access Channel. + + :param str analytics_instance_id: (required) + The OCID of the AnalyticsInstance. + + :param oci.analytics.models.UpdatePrivateAccessChannelDetails update_private_access_channel_details: (required) + Update the Private Access Channel with the given unique identifier key in the specified Analytics Instance. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.analytics.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.analytics.AnalyticsClient.update_private_access_channel` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.update_private_access_channel(private_access_channel_key, analytics_instance_id, update_private_access_channel_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def update_vanity_url_and_wait_for_state(self, analytics_instance_id, vanity_url_key, update_vanity_url_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.analytics.AnalyticsClient.update_vanity_url` and waits for the :py:class:`~oci.analytics.models.WorkRequest` + to enter the given state(s). + + :param str analytics_instance_id: (required) + The OCID of the AnalyticsInstance. + + :param str vanity_url_key: (required) + Specify unique identifier key of a vanity url to update or delete. + + :param oci.analytics.models.UpdateVanityUrlDetails update_vanity_url_details: (required) + Vanity url details to update (certificate). + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.analytics.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.analytics.AnalyticsClient.update_vanity_url` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.update_vanity_url(analytics_instance_id, vanity_url_key, update_vanity_url_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) diff --git a/src/oci/analytics/models/__init__.py b/src/oci/analytics/models/__init__.py index f7a4527340..b5dde6dfdc 100644 --- a/src/oci/analytics/models/__init__.py +++ b/src/oci/analytics/models/__init__.py @@ -10,11 +10,18 @@ from .change_analytics_instance_network_endpoint_details import ChangeAnalyticsInstanceNetworkEndpointDetails from .change_compartment_details import ChangeCompartmentDetails from .create_analytics_instance_details import CreateAnalyticsInstanceDetails +from .create_private_access_channel_details import CreatePrivateAccessChannelDetails +from .create_vanity_url_details import CreateVanityUrlDetails from .network_endpoint_details import NetworkEndpointDetails +from .private_access_channel import PrivateAccessChannel from .private_endpoint_details import PrivateEndpointDetails +from .private_source_dns_zone import PrivateSourceDnsZone from .public_endpoint_details import PublicEndpointDetails from .scale_analytics_instance_details import ScaleAnalyticsInstanceDetails from .update_analytics_instance_details import UpdateAnalyticsInstanceDetails +from .update_private_access_channel_details import UpdatePrivateAccessChannelDetails +from .update_vanity_url_details import UpdateVanityUrlDetails +from .vanity_url_details import VanityUrlDetails from .virtual_cloud_network import VirtualCloudNetwork from .work_request import WorkRequest from .work_request_error import WorkRequestError @@ -30,11 +37,18 @@ "ChangeAnalyticsInstanceNetworkEndpointDetails": ChangeAnalyticsInstanceNetworkEndpointDetails, "ChangeCompartmentDetails": ChangeCompartmentDetails, "CreateAnalyticsInstanceDetails": CreateAnalyticsInstanceDetails, + "CreatePrivateAccessChannelDetails": CreatePrivateAccessChannelDetails, + "CreateVanityUrlDetails": CreateVanityUrlDetails, "NetworkEndpointDetails": NetworkEndpointDetails, + "PrivateAccessChannel": PrivateAccessChannel, "PrivateEndpointDetails": PrivateEndpointDetails, + "PrivateSourceDnsZone": PrivateSourceDnsZone, "PublicEndpointDetails": PublicEndpointDetails, "ScaleAnalyticsInstanceDetails": ScaleAnalyticsInstanceDetails, "UpdateAnalyticsInstanceDetails": UpdateAnalyticsInstanceDetails, + "UpdatePrivateAccessChannelDetails": UpdatePrivateAccessChannelDetails, + "UpdateVanityUrlDetails": UpdateVanityUrlDetails, + "VanityUrlDetails": VanityUrlDetails, "VirtualCloudNetwork": VirtualCloudNetwork, "WorkRequest": WorkRequest, "WorkRequestError": WorkRequestError, diff --git a/src/oci/analytics/models/analytics_instance.py b/src/oci/analytics/models/analytics_instance.py index fabb7534ff..ceecde00df 100644 --- a/src/oci/analytics/models/analytics_instance.py +++ b/src/oci/analytics/models/analytics_instance.py @@ -108,6 +108,14 @@ def __init__(self, **kwargs): The value to assign to the network_endpoint_details property of this AnalyticsInstance. :type network_endpoint_details: oci.analytics.models.NetworkEndpointDetails + :param private_access_channels: + The value to assign to the private_access_channels property of this AnalyticsInstance. + :type private_access_channels: dict(str, PrivateAccessChannel) + + :param vanity_url_details: + The value to assign to the vanity_url_details property of this AnalyticsInstance. + :type vanity_url_details: dict(str, VanityUrlDetails) + :param service_url: The value to assign to the service_url property of this AnalyticsInstance. :type service_url: str @@ -140,6 +148,8 @@ def __init__(self, **kwargs): 'license_type': 'str', 'email_notification': 'str', 'network_endpoint_details': 'NetworkEndpointDetails', + 'private_access_channels': 'dict(str, PrivateAccessChannel)', + 'vanity_url_details': 'dict(str, VanityUrlDetails)', 'service_url': 'str', 'defined_tags': 'dict(str, dict(str, object))', 'freeform_tags': 'dict(str, str)', @@ -158,6 +168,8 @@ def __init__(self, **kwargs): 'license_type': 'licenseType', 'email_notification': 'emailNotification', 'network_endpoint_details': 'networkEndpointDetails', + 'private_access_channels': 'privateAccessChannels', + 'vanity_url_details': 'vanityUrlDetails', 'service_url': 'serviceUrl', 'defined_tags': 'definedTags', 'freeform_tags': 'freeformTags', @@ -175,6 +187,8 @@ def __init__(self, **kwargs): self._license_type = None self._email_notification = None self._network_endpoint_details = None + self._private_access_channels = None + self._vanity_url_details = None self._service_url = None self._defined_tags = None self._freeform_tags = None @@ -431,6 +445,54 @@ def network_endpoint_details(self, network_endpoint_details): """ self._network_endpoint_details = network_endpoint_details + @property + def private_access_channels(self): + """ + Gets the private_access_channels of this AnalyticsInstance. + Map of PrivateAccessChannel unique identifier key as KEY and PrivateAccessChannel Object as VALUE. + + + :return: The private_access_channels of this AnalyticsInstance. + :rtype: dict(str, PrivateAccessChannel) + """ + return self._private_access_channels + + @private_access_channels.setter + def private_access_channels(self, private_access_channels): + """ + Sets the private_access_channels of this AnalyticsInstance. + Map of PrivateAccessChannel unique identifier key as KEY and PrivateAccessChannel Object as VALUE. + + + :param private_access_channels: The private_access_channels of this AnalyticsInstance. + :type: dict(str, PrivateAccessChannel) + """ + self._private_access_channels = private_access_channels + + @property + def vanity_url_details(self): + """ + Gets the vanity_url_details of this AnalyticsInstance. + Map of VanityUrl unique identifier key as KEY and VanityUrl Object as VALUE. + + + :return: The vanity_url_details of this AnalyticsInstance. + :rtype: dict(str, VanityUrlDetails) + """ + return self._vanity_url_details + + @vanity_url_details.setter + def vanity_url_details(self, vanity_url_details): + """ + Sets the vanity_url_details of this AnalyticsInstance. + Map of VanityUrl unique identifier key as KEY and VanityUrl Object as VALUE. + + + :param vanity_url_details: The vanity_url_details of this AnalyticsInstance. + :type: dict(str, VanityUrlDetails) + """ + self._vanity_url_details = vanity_url_details + @property def service_url(self): """ diff --git a/src/oci/analytics/models/create_private_access_channel_details.py b/src/oci/analytics/models/create_private_access_channel_details.py new file mode 100644 index 0000000000..8638e0b7d6 --- /dev/null +++ b/src/oci/analytics/models/create_private_access_channel_details.py @@ -0,0 +1,167 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreatePrivateAccessChannelDetails(object): + """ + Input payload to create a Private Access Channel. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreatePrivateAccessChannelDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param display_name: + The value to assign to the display_name property of this CreatePrivateAccessChannelDetails. + :type display_name: str + + :param vcn_id: + The value to assign to the vcn_id property of this CreatePrivateAccessChannelDetails. + :type vcn_id: str + + :param subnet_id: + The value to assign to the subnet_id property of this CreatePrivateAccessChannelDetails. + :type subnet_id: str + + :param private_source_dns_zones: + The value to assign to the private_source_dns_zones property of this CreatePrivateAccessChannelDetails. + :type private_source_dns_zones: list[oci.analytics.models.PrivateSourceDnsZone] + + """ + self.swagger_types = { + 'display_name': 'str', + 'vcn_id': 'str', + 'subnet_id': 'str', + 'private_source_dns_zones': 'list[PrivateSourceDnsZone]' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'vcn_id': 'vcnId', + 'subnet_id': 'subnetId', + 'private_source_dns_zones': 'privateSourceDnsZones' + } + + self._display_name = None + self._vcn_id = None + self._subnet_id = None + self._private_source_dns_zones = None + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this CreatePrivateAccessChannelDetails. + Display Name of the Private Access Channel. + + + :return: The display_name of this CreatePrivateAccessChannelDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreatePrivateAccessChannelDetails. + Display Name of the Private Access Channel. + + + :param display_name: The display_name of this CreatePrivateAccessChannelDetails. + :type: str + """ + self._display_name = display_name + + @property + def vcn_id(self): + """ + **[Required]** Gets the vcn_id of this CreatePrivateAccessChannelDetails. + OCID of the customer VCN peered with private access channel. + + + :return: The vcn_id of this CreatePrivateAccessChannelDetails. + :rtype: str + """ + return self._vcn_id + + @vcn_id.setter + def vcn_id(self, vcn_id): + """ + Sets the vcn_id of this CreatePrivateAccessChannelDetails. + OCID of the customer VCN peered with private access channel. + + + :param vcn_id: The vcn_id of this CreatePrivateAccessChannelDetails. + :type: str + """ + self._vcn_id = vcn_id + + @property + def subnet_id(self): + """ + **[Required]** Gets the subnet_id of this CreatePrivateAccessChannelDetails. + OCID of the customer subnet connected to private access channel. + + + :return: The subnet_id of this CreatePrivateAccessChannelDetails. + :rtype: str + """ + return self._subnet_id + + @subnet_id.setter + def subnet_id(self, subnet_id): + """ + Sets the subnet_id of this CreatePrivateAccessChannelDetails. + OCID of the customer subnet connected to private access channel. + + + :param subnet_id: The subnet_id of this CreatePrivateAccessChannelDetails. + :type: str + """ + self._subnet_id = subnet_id + + @property + def private_source_dns_zones(self): + """ + **[Required]** Gets the private_source_dns_zones of this CreatePrivateAccessChannelDetails. + List of Private Source DNS zones registered with Private Access Channel, + where datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance. + Min of 1 is required and Max of 30 Private Source DNS zones can be registered. + + + :return: The private_source_dns_zones of this CreatePrivateAccessChannelDetails. + :rtype: list[oci.analytics.models.PrivateSourceDnsZone] + """ + return self._private_source_dns_zones + + @private_source_dns_zones.setter + def private_source_dns_zones(self, private_source_dns_zones): + """ + Sets the private_source_dns_zones of this CreatePrivateAccessChannelDetails. + List of Private Source DNS zones registered with Private Access Channel, + where datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance. + Min of 1 is required and Max of 30 Private Source DNS zones can be registered. + + + :param private_source_dns_zones: The private_source_dns_zones of this CreatePrivateAccessChannelDetails. + :type: list[oci.analytics.models.PrivateSourceDnsZone] + """ + self._private_source_dns_zones = private_source_dns_zones + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/analytics/models/create_vanity_url_details.py b/src/oci/analytics/models/create_vanity_url_details.py new file mode 100644 index 0000000000..06d753516d --- /dev/null +++ b/src/oci/analytics/models/create_vanity_url_details.py @@ -0,0 +1,225 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateVanityUrlDetails(object): + """ + Input payload to create a vanity url. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateVanityUrlDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param description: + The value to assign to the description property of this CreateVanityUrlDetails. + :type description: str + + :param hosts: + The value to assign to the hosts property of this CreateVanityUrlDetails. + :type hosts: list[str] + + :param passphrase: + The value to assign to the passphrase property of this CreateVanityUrlDetails. + :type passphrase: str + + :param private_key: + The value to assign to the private_key property of this CreateVanityUrlDetails. + :type private_key: str + + :param public_certificate: + The value to assign to the public_certificate property of this CreateVanityUrlDetails. + :type public_certificate: str + + :param ca_certificate: + The value to assign to the ca_certificate property of this CreateVanityUrlDetails. + :type ca_certificate: str + + """ + self.swagger_types = { + 'description': 'str', + 'hosts': 'list[str]', + 'passphrase': 'str', + 'private_key': 'str', + 'public_certificate': 'str', + 'ca_certificate': 'str' + } + + self.attribute_map = { + 'description': 'description', + 'hosts': 'hosts', + 'passphrase': 'passphrase', + 'private_key': 'privateKey', + 'public_certificate': 'publicCertificate', + 'ca_certificate': 'caCertificate' + } + + self._description = None + self._hosts = None + self._passphrase = None + self._private_key = None + self._public_certificate = None + self._ca_certificate = None + + @property + def description(self): + """ + Gets the description of this CreateVanityUrlDetails. + Optional description. + + + :return: The description of this CreateVanityUrlDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this CreateVanityUrlDetails. + Optional description. + + + :param description: The description of this CreateVanityUrlDetails. + :type: str + """ + self._description = description + + @property + def hosts(self): + """ + **[Required]** Gets the hosts of this CreateVanityUrlDetails. + List of fully qualified hostnames supported by this vanity URL definition (max of 3). + + + :return: The hosts of this CreateVanityUrlDetails. + :rtype: list[str] + """ + return self._hosts + + @hosts.setter + def hosts(self, hosts): + """ + Sets the hosts of this CreateVanityUrlDetails. + List of fully qualified hostnames supported by this vanity URL definition (max of 3). + + + :param hosts: The hosts of this CreateVanityUrlDetails. + :type: list[str] + """ + self._hosts = hosts + + @property + def passphrase(self): + """ + Gets the passphrase of this CreateVanityUrlDetails. + Passphrase for the PEM Private key (if any). + + + :return: The passphrase of this CreateVanityUrlDetails. + :rtype: str + """ + return self._passphrase + + @passphrase.setter + def passphrase(self, passphrase): + """ + Sets the passphrase of this CreateVanityUrlDetails. + Passphrase for the PEM Private key (if any). + + + :param passphrase: The passphrase of this CreateVanityUrlDetails. + :type: str + """ + self._passphrase = passphrase + + @property + def private_key(self): + """ + **[Required]** Gets the private_key of this CreateVanityUrlDetails. + PEM Private key for HTTPS connections. + + + :return: The private_key of this CreateVanityUrlDetails. + :rtype: str + """ + return self._private_key + + @private_key.setter + def private_key(self, private_key): + """ + Sets the private_key of this CreateVanityUrlDetails. + PEM Private key for HTTPS connections. + + + :param private_key: The private_key of this CreateVanityUrlDetails. + :type: str + """ + self._private_key = private_key + + @property + def public_certificate(self): + """ + **[Required]** Gets the public_certificate of this CreateVanityUrlDetails. + PEM certificate for HTTPS connections. + + + :return: The public_certificate of this CreateVanityUrlDetails. + :rtype: str + """ + return self._public_certificate + + @public_certificate.setter + def public_certificate(self, public_certificate): + """ + Sets the public_certificate of this CreateVanityUrlDetails. + PEM certificate for HTTPS connections. + + + :param public_certificate: The public_certificate of this CreateVanityUrlDetails. + :type: str + """ + self._public_certificate = public_certificate + + @property + def ca_certificate(self): + """ + **[Required]** Gets the ca_certificate of this CreateVanityUrlDetails. + PEM CA certificate(s) for HTTPS connections. This may include multiple PEM certificates. + + + :return: The ca_certificate of this CreateVanityUrlDetails. + :rtype: str + """ + return self._ca_certificate + + @ca_certificate.setter + def ca_certificate(self, ca_certificate): + """ + Sets the ca_certificate of this CreateVanityUrlDetails. + PEM CA certificate(s) for HTTPS connections. This may include multiple PEM certificates. + + + :param ca_certificate: The ca_certificate of this CreateVanityUrlDetails. + :type: str + """ + self._ca_certificate = ca_certificate + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/analytics/models/private_access_channel.py b/src/oci/analytics/models/private_access_channel.py new file mode 100644 index 0000000000..8f7f386d6d --- /dev/null +++ b/src/oci/analytics/models/private_access_channel.py @@ -0,0 +1,262 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class PrivateAccessChannel(object): + """ + Analytics Instance Private Access Channel model. + """ + + def __init__(self, **kwargs): + """ + Initializes a new PrivateAccessChannel object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param key: + The value to assign to the key property of this PrivateAccessChannel. + :type key: str + + :param display_name: + The value to assign to the display_name property of this PrivateAccessChannel. + :type display_name: str + + :param vcn_id: + The value to assign to the vcn_id property of this PrivateAccessChannel. + :type vcn_id: str + + :param subnet_id: + The value to assign to the subnet_id property of this PrivateAccessChannel. + :type subnet_id: str + + :param ip_address: + The value to assign to the ip_address property of this PrivateAccessChannel. + :type ip_address: str + + :param egress_source_ip_addresses: + The value to assign to the egress_source_ip_addresses property of this PrivateAccessChannel. + :type egress_source_ip_addresses: list[str] + + :param private_source_dns_zones: + The value to assign to the private_source_dns_zones property of this PrivateAccessChannel. + :type private_source_dns_zones: list[oci.analytics.models.PrivateSourceDnsZone] + + """ + self.swagger_types = { + 'key': 'str', + 'display_name': 'str', + 'vcn_id': 'str', + 'subnet_id': 'str', + 'ip_address': 'str', + 'egress_source_ip_addresses': 'list[str]', + 'private_source_dns_zones': 'list[PrivateSourceDnsZone]' + } + + self.attribute_map = { + 'key': 'key', + 'display_name': 'displayName', + 'vcn_id': 'vcnId', + 'subnet_id': 'subnetId', + 'ip_address': 'ipAddress', + 'egress_source_ip_addresses': 'egressSourceIpAddresses', + 'private_source_dns_zones': 'privateSourceDnsZones' + } + + self._key = None + self._display_name = None + self._vcn_id = None + self._subnet_id = None + self._ip_address = None + self._egress_source_ip_addresses = None + self._private_source_dns_zones = None + + @property + def key(self): + """ + **[Required]** Gets the key of this PrivateAccessChannel. + Private Access Channel unique identifier key. + + + :return: The key of this PrivateAccessChannel. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this PrivateAccessChannel. + Private Access Channel unique identifier key. + + + :param key: The key of this PrivateAccessChannel. + :type: str + """ + self._key = key + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this PrivateAccessChannel. + Display Name of the Private Access Channel. + + + :return: The display_name of this PrivateAccessChannel. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this PrivateAccessChannel. + Display Name of the Private Access Channel. + + + :param display_name: The display_name of this PrivateAccessChannel. + :type: str + """ + self._display_name = display_name + + @property + def vcn_id(self): + """ + **[Required]** Gets the vcn_id of this PrivateAccessChannel. + OCID of the customer VCN peered with private access channel. + + + :return: The vcn_id of this PrivateAccessChannel. + :rtype: str + """ + return self._vcn_id + + @vcn_id.setter + def vcn_id(self, vcn_id): + """ + Sets the vcn_id of this PrivateAccessChannel. + OCID of the customer VCN peered with private access channel. + + + :param vcn_id: The vcn_id of this PrivateAccessChannel. + :type: str + """ + self._vcn_id = vcn_id + + @property + def subnet_id(self): + """ + **[Required]** Gets the subnet_id of this PrivateAccessChannel. + OCID of the customer subnet connected to private access channel. + + + :return: The subnet_id of this PrivateAccessChannel. + :rtype: str + """ + return self._subnet_id + + @subnet_id.setter + def subnet_id(self, subnet_id): + """ + Sets the subnet_id of this PrivateAccessChannel. + OCID of the customer subnet connected to private access channel. + + + :param subnet_id: The subnet_id of this PrivateAccessChannel. + :type: str + """ + self._subnet_id = subnet_id + + @property + def ip_address(self): + """ + **[Required]** Gets the ip_address of this PrivateAccessChannel. + IP Address of the Private Access channel. + + + :return: The ip_address of this PrivateAccessChannel. + :rtype: str + """ + return self._ip_address + + @ip_address.setter + def ip_address(self, ip_address): + """ + Sets the ip_address of this PrivateAccessChannel. + IP Address of the Private Access channel. + + + :param ip_address: The ip_address of this PrivateAccessChannel. + :type: str + """ + self._ip_address = ip_address + + @property + def egress_source_ip_addresses(self): + """ + **[Required]** Gets the egress_source_ip_addresses of this PrivateAccessChannel. + The list of IP addresses from the customer subnet connected to private access channel, used as a source Ip by Private Access Channel + for network traffic from the AnalyticsInstance to Private Sources. + + + :return: The egress_source_ip_addresses of this PrivateAccessChannel. + :rtype: list[str] + """ + return self._egress_source_ip_addresses + + @egress_source_ip_addresses.setter + def egress_source_ip_addresses(self, egress_source_ip_addresses): + """ + Sets the egress_source_ip_addresses of this PrivateAccessChannel. + The list of IP addresses from the customer subnet connected to private access channel, used as a source Ip by Private Access Channel + for network traffic from the AnalyticsInstance to Private Sources. + + + :param egress_source_ip_addresses: The egress_source_ip_addresses of this PrivateAccessChannel. + :type: list[str] + """ + self._egress_source_ip_addresses = egress_source_ip_addresses + + @property + def private_source_dns_zones(self): + """ + Gets the private_source_dns_zones of this PrivateAccessChannel. + List of Private Source DNS zones registered with Private Access Channel, + where datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance. + Min of 1 is required and Max of 30 Private Source DNS zones can be registered. + + + :return: The private_source_dns_zones of this PrivateAccessChannel. + :rtype: list[oci.analytics.models.PrivateSourceDnsZone] + """ + return self._private_source_dns_zones + + @private_source_dns_zones.setter + def private_source_dns_zones(self, private_source_dns_zones): + """ + Sets the private_source_dns_zones of this PrivateAccessChannel. + List of Private Source DNS zones registered with Private Access Channel, + where datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance. + Min of 1 is required and Max of 30 Private Source DNS zones can be registered. + + + :param private_source_dns_zones: The private_source_dns_zones of this PrivateAccessChannel. + :type: list[oci.analytics.models.PrivateSourceDnsZone] + """ + self._private_source_dns_zones = private_source_dns_zones + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/analytics/models/private_source_dns_zone.py b/src/oci/analytics/models/private_source_dns_zone.py new file mode 100644 index 0000000000..57512a53a6 --- /dev/null +++ b/src/oci/analytics/models/private_source_dns_zone.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class PrivateSourceDnsZone(object): + """ + Private source DNS Zone model. + """ + + def __init__(self, **kwargs): + """ + Initializes a new PrivateSourceDnsZone object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param dns_zone: + The value to assign to the dns_zone property of this PrivateSourceDnsZone. + :type dns_zone: str + + :param description: + The value to assign to the description property of this PrivateSourceDnsZone. + :type description: str + + """ + self.swagger_types = { + 'dns_zone': 'str', + 'description': 'str' + } + + self.attribute_map = { + 'dns_zone': 'dnsZone', + 'description': 'description' + } + + self._dns_zone = None + self._description = None + + @property + def dns_zone(self): + """ + **[Required]** Gets the dns_zone of this PrivateSourceDnsZone. + Private Source DNS Zone. Ex: example-vcn.oraclevcn.com, corp.example.com. + + + :return: The dns_zone of this PrivateSourceDnsZone. + :rtype: str + """ + return self._dns_zone + + @dns_zone.setter + def dns_zone(self, dns_zone): + """ + Sets the dns_zone of this PrivateSourceDnsZone. + Private Source DNS Zone. Ex: example-vcn.oraclevcn.com, corp.example.com. + + + :param dns_zone: The dns_zone of this PrivateSourceDnsZone. + :type: str + """ + self._dns_zone = dns_zone + + @property + def description(self): + """ + Gets the description of this PrivateSourceDnsZone. + Description of private source dns zone. + + + :return: The description of this PrivateSourceDnsZone. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this PrivateSourceDnsZone. + Description of private source dns zone. + + + :param description: The description of this PrivateSourceDnsZone. + :type: str + """ + self._description = description + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/analytics/models/update_private_access_channel_details.py b/src/oci/analytics/models/update_private_access_channel_details.py new file mode 100644 index 0000000000..7128a6d5b4 --- /dev/null +++ b/src/oci/analytics/models/update_private_access_channel_details.py @@ -0,0 +1,167 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdatePrivateAccessChannelDetails(object): + """ + Input payload to update a Private Access Channel. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdatePrivateAccessChannelDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param display_name: + The value to assign to the display_name property of this UpdatePrivateAccessChannelDetails. + :type display_name: str + + :param vcn_id: + The value to assign to the vcn_id property of this UpdatePrivateAccessChannelDetails. + :type vcn_id: str + + :param subnet_id: + The value to assign to the subnet_id property of this UpdatePrivateAccessChannelDetails. + :type subnet_id: str + + :param private_source_dns_zones: + The value to assign to the private_source_dns_zones property of this UpdatePrivateAccessChannelDetails. + :type private_source_dns_zones: list[oci.analytics.models.PrivateSourceDnsZone] + + """ + self.swagger_types = { + 'display_name': 'str', + 'vcn_id': 'str', + 'subnet_id': 'str', + 'private_source_dns_zones': 'list[PrivateSourceDnsZone]' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'vcn_id': 'vcnId', + 'subnet_id': 'subnetId', + 'private_source_dns_zones': 'privateSourceDnsZones' + } + + self._display_name = None + self._vcn_id = None + self._subnet_id = None + self._private_source_dns_zones = None + + @property + def display_name(self): + """ + Gets the display_name of this UpdatePrivateAccessChannelDetails. + Display Name of the Private Access Channel. + + + :return: The display_name of this UpdatePrivateAccessChannelDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this UpdatePrivateAccessChannelDetails. + Display Name of the Private Access Channel. + + + :param display_name: The display_name of this UpdatePrivateAccessChannelDetails. + :type: str + """ + self._display_name = display_name + + @property + def vcn_id(self): + """ + Gets the vcn_id of this UpdatePrivateAccessChannelDetails. + OCID of the customer VCN peered with private access channel. + + + :return: The vcn_id of this UpdatePrivateAccessChannelDetails. + :rtype: str + """ + return self._vcn_id + + @vcn_id.setter + def vcn_id(self, vcn_id): + """ + Sets the vcn_id of this UpdatePrivateAccessChannelDetails. + OCID of the customer VCN peered with private access channel. + + + :param vcn_id: The vcn_id of this UpdatePrivateAccessChannelDetails. + :type: str + """ + self._vcn_id = vcn_id + + @property + def subnet_id(self): + """ + Gets the subnet_id of this UpdatePrivateAccessChannelDetails. + OCID of the customer subnet connected to private access channel. + + + :return: The subnet_id of this UpdatePrivateAccessChannelDetails. + :rtype: str + """ + return self._subnet_id + + @subnet_id.setter + def subnet_id(self, subnet_id): + """ + Sets the subnet_id of this UpdatePrivateAccessChannelDetails. + OCID of the customer subnet connected to private access channel. + + + :param subnet_id: The subnet_id of this UpdatePrivateAccessChannelDetails. + :type: str + """ + self._subnet_id = subnet_id + + @property + def private_source_dns_zones(self): + """ + Gets the private_source_dns_zones of this UpdatePrivateAccessChannelDetails. + List of Private Source DNS zones registered with Private Access Channel, + where datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance. + Min of 1 is required and Max of 30 Private Source DNS zones can be registered. + + + :return: The private_source_dns_zones of this UpdatePrivateAccessChannelDetails. + :rtype: list[oci.analytics.models.PrivateSourceDnsZone] + """ + return self._private_source_dns_zones + + @private_source_dns_zones.setter + def private_source_dns_zones(self, private_source_dns_zones): + """ + Sets the private_source_dns_zones of this UpdatePrivateAccessChannelDetails. + List of Private Source DNS zones registered with Private Access Channel, + where datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance. + Min of 1 is required and Max of 30 Private Source DNS zones can be registered. + + + :param private_source_dns_zones: The private_source_dns_zones of this UpdatePrivateAccessChannelDetails. + :type: list[oci.analytics.models.PrivateSourceDnsZone] + """ + self._private_source_dns_zones = private_source_dns_zones + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/analytics/models/update_vanity_url_details.py b/src/oci/analytics/models/update_vanity_url_details.py new file mode 100644 index 0000000000..cc5e6f51b9 --- /dev/null +++ b/src/oci/analytics/models/update_vanity_url_details.py @@ -0,0 +1,163 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdateVanityUrlDetails(object): + """ + Input payload to update a vanity url. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateVanityUrlDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param passphrase: + The value to assign to the passphrase property of this UpdateVanityUrlDetails. + :type passphrase: str + + :param private_key: + The value to assign to the private_key property of this UpdateVanityUrlDetails. + :type private_key: str + + :param public_certificate: + The value to assign to the public_certificate property of this UpdateVanityUrlDetails. + :type public_certificate: str + + :param ca_certificate: + The value to assign to the ca_certificate property of this UpdateVanityUrlDetails. + :type ca_certificate: str + + """ + self.swagger_types = { + 'passphrase': 'str', + 'private_key': 'str', + 'public_certificate': 'str', + 'ca_certificate': 'str' + } + + self.attribute_map = { + 'passphrase': 'passphrase', + 'private_key': 'privateKey', + 'public_certificate': 'publicCertificate', + 'ca_certificate': 'caCertificate' + } + + self._passphrase = None + self._private_key = None + self._public_certificate = None + self._ca_certificate = None + + @property + def passphrase(self): + """ + Gets the passphrase of this UpdateVanityUrlDetails. + Passphrase for the PEM Private key (if any). + + + :return: The passphrase of this UpdateVanityUrlDetails. + :rtype: str + """ + return self._passphrase + + @passphrase.setter + def passphrase(self, passphrase): + """ + Sets the passphrase of this UpdateVanityUrlDetails. + Passphrase for the PEM Private key (if any). + + + :param passphrase: The passphrase of this UpdateVanityUrlDetails. + :type: str + """ + self._passphrase = passphrase + + @property + def private_key(self): + """ + **[Required]** Gets the private_key of this UpdateVanityUrlDetails. + PEM Private key for HTTPS connections. + + + :return: The private_key of this UpdateVanityUrlDetails. + :rtype: str + """ + return self._private_key + + @private_key.setter + def private_key(self, private_key): + """ + Sets the private_key of this UpdateVanityUrlDetails. + PEM Private key for HTTPS connections. + + + :param private_key: The private_key of this UpdateVanityUrlDetails. + :type: str + """ + self._private_key = private_key + + @property + def public_certificate(self): + """ + **[Required]** Gets the public_certificate of this UpdateVanityUrlDetails. + PEM certificate for HTTPS connections. + + + :return: The public_certificate of this UpdateVanityUrlDetails. + :rtype: str + """ + return self._public_certificate + + @public_certificate.setter + def public_certificate(self, public_certificate): + """ + Sets the public_certificate of this UpdateVanityUrlDetails. + PEM certificate for HTTPS connections. + + + :param public_certificate: The public_certificate of this UpdateVanityUrlDetails. + :type: str + """ + self._public_certificate = public_certificate + + @property + def ca_certificate(self): + """ + **[Required]** Gets the ca_certificate of this UpdateVanityUrlDetails. + PEM CA certificate(s) for HTTPS connections. This may include multiple PEM certificates. + + + :return: The ca_certificate of this UpdateVanityUrlDetails. + :rtype: str + """ + return self._ca_certificate + + @ca_certificate.setter + def ca_certificate(self, ca_certificate): + """ + Sets the ca_certificate of this UpdateVanityUrlDetails. + PEM CA certificate(s) for HTTPS connections. This may include multiple PEM certificates. + + + :param ca_certificate: The ca_certificate of this UpdateVanityUrlDetails. + :type: str + """ + self._ca_certificate = ca_certificate + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/analytics/models/vanity_url_details.py b/src/oci/analytics/models/vanity_url_details.py new file mode 100644 index 0000000000..e54ff84954 --- /dev/null +++ b/src/oci/analytics/models/vanity_url_details.py @@ -0,0 +1,194 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VanityUrlDetails(object): + """ + Vanity url configuration details. + """ + + def __init__(self, **kwargs): + """ + Initializes a new VanityUrlDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param key: + The value to assign to the key property of this VanityUrlDetails. + :type key: str + + :param description: + The value to assign to the description property of this VanityUrlDetails. + :type description: str + + :param urls: + The value to assign to the urls property of this VanityUrlDetails. + :type urls: list[str] + + :param hosts: + The value to assign to the hosts property of this VanityUrlDetails. + :type hosts: list[str] + + :param public_certificate: + The value to assign to the public_certificate property of this VanityUrlDetails. + :type public_certificate: str + + """ + self.swagger_types = { + 'key': 'str', + 'description': 'str', + 'urls': 'list[str]', + 'hosts': 'list[str]', + 'public_certificate': 'str' + } + + self.attribute_map = { + 'key': 'key', + 'description': 'description', + 'urls': 'urls', + 'hosts': 'hosts', + 'public_certificate': 'publicCertificate' + } + + self._key = None + self._description = None + self._urls = None + self._hosts = None + self._public_certificate = None + + @property + def key(self): + """ + Gets the key of this VanityUrlDetails. + The vanity url unique identifier key. + + + :return: The key of this VanityUrlDetails. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this VanityUrlDetails. + The vanity url unique identifier key. + + + :param key: The key of this VanityUrlDetails. + :type: str + """ + self._key = key + + @property + def description(self): + """ + Gets the description of this VanityUrlDetails. + Description of the vanity url. + + + :return: The description of this VanityUrlDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this VanityUrlDetails. + Description of the vanity url. + + + :param description: The description of this VanityUrlDetails. + :type: str + """ + self._description = description + + @property + def urls(self): + """ + Gets the urls of this VanityUrlDetails. + List of urls supported by this vanity URL definition (max of 3). + + + :return: The urls of this VanityUrlDetails. + :rtype: list[str] + """ + return self._urls + + @urls.setter + def urls(self, urls): + """ + Sets the urls of this VanityUrlDetails. + List of urls supported by this vanity URL definition (max of 3). + + + :param urls: The urls of this VanityUrlDetails. + :type: list[str] + """ + self._urls = urls + + @property + def hosts(self): + """ + Gets the hosts of this VanityUrlDetails. + List of fully qualified hostnames supported by this vanity URL definition (max of 3). + + + :return: The hosts of this VanityUrlDetails. + :rtype: list[str] + """ + return self._hosts + + @hosts.setter + def hosts(self, hosts): + """ + Sets the hosts of this VanityUrlDetails. + List of fully qualified hostnames supported by this vanity URL definition (max of 3). + + + :param hosts: The hosts of this VanityUrlDetails. + :type: list[str] + """ + self._hosts = hosts + + @property + def public_certificate(self): + """ + Gets the public_certificate of this VanityUrlDetails. + PEM certificate for HTTPS connections. + + + :return: The public_certificate of this VanityUrlDetails. + :rtype: str + """ + return self._public_certificate + + @public_certificate.setter + def public_certificate(self, public_certificate): + """ + Sets the public_certificate of this VanityUrlDetails. + PEM certificate for HTTPS connections. + + + :param public_certificate: The public_certificate of this VanityUrlDetails. + :type: str + """ + self._public_certificate = public_certificate + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/analytics/models/work_request.py b/src/oci/analytics/models/work_request.py index a425ad9b74..7e46b0cfbe 100644 --- a/src/oci/analytics/models/work_request.py +++ b/src/oci/analytics/models/work_request.py @@ -41,6 +41,30 @@ class WorkRequest(object): #: This constant has a value of "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT" OPERATION_TYPE_CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT = "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT" + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "CREATE_VANITY_URL" + OPERATION_TYPE_CREATE_VANITY_URL = "CREATE_VANITY_URL" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "UPDATE_VANITY_URL" + OPERATION_TYPE_UPDATE_VANITY_URL = "UPDATE_VANITY_URL" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "DELETE_VANITY_URL" + OPERATION_TYPE_DELETE_VANITY_URL = "DELETE_VANITY_URL" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "CREATE_PRIVATE_ACCESS_CHANNEL" + OPERATION_TYPE_CREATE_PRIVATE_ACCESS_CHANNEL = "CREATE_PRIVATE_ACCESS_CHANNEL" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "UPDATE_PRIVATE_ACCESS_CHANNEL" + OPERATION_TYPE_UPDATE_PRIVATE_ACCESS_CHANNEL = "UPDATE_PRIVATE_ACCESS_CHANNEL" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "DELETE_PRIVATE_ACCESS_CHANNEL" + OPERATION_TYPE_DELETE_PRIVATE_ACCESS_CHANNEL = "DELETE_PRIVATE_ACCESS_CHANNEL" + #: A constant which can be used with the status property of a WorkRequest. #: This constant has a value of "ACCEPTED" STATUS_ACCEPTED = "ACCEPTED" @@ -76,7 +100,7 @@ def __init__(self, **kwargs): :param operation_type: The value to assign to the operation_type property of this WorkRequest. - Allowed values for this property are: "CREATE_ANALYTICS_INSTANCE", "DELETE_ANALYTICS_INSTANCE", "START_ANALYTICS_INSTANCE", "STOP_ANALYTICS_INSTANCE", "SCALE_ANALYTICS_INSTANCE", "CHANGE_ANALYTICS_INSTANCE_COMPARTMENT", "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_ANALYTICS_INSTANCE", "DELETE_ANALYTICS_INSTANCE", "START_ANALYTICS_INSTANCE", "STOP_ANALYTICS_INSTANCE", "SCALE_ANALYTICS_INSTANCE", "CHANGE_ANALYTICS_INSTANCE_COMPARTMENT", "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT", "CREATE_VANITY_URL", "UPDATE_VANITY_URL", "DELETE_VANITY_URL", "CREATE_PRIVATE_ACCESS_CHANNEL", "UPDATE_PRIVATE_ACCESS_CHANNEL", "DELETE_PRIVATE_ACCESS_CHANNEL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type operation_type: str @@ -175,7 +199,7 @@ def operation_type(self): **[Required]** Gets the operation_type of this WorkRequest. The operation performed by the work request. - Allowed values for this property are: "CREATE_ANALYTICS_INSTANCE", "DELETE_ANALYTICS_INSTANCE", "START_ANALYTICS_INSTANCE", "STOP_ANALYTICS_INSTANCE", "SCALE_ANALYTICS_INSTANCE", "CHANGE_ANALYTICS_INSTANCE_COMPARTMENT", "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_ANALYTICS_INSTANCE", "DELETE_ANALYTICS_INSTANCE", "START_ANALYTICS_INSTANCE", "STOP_ANALYTICS_INSTANCE", "SCALE_ANALYTICS_INSTANCE", "CHANGE_ANALYTICS_INSTANCE_COMPARTMENT", "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT", "CREATE_VANITY_URL", "UPDATE_VANITY_URL", "DELETE_VANITY_URL", "CREATE_PRIVATE_ACCESS_CHANNEL", "UPDATE_PRIVATE_ACCESS_CHANNEL", "DELETE_PRIVATE_ACCESS_CHANNEL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -194,7 +218,7 @@ def operation_type(self, operation_type): :param operation_type: The operation_type of this WorkRequest. :type: str """ - allowed_values = ["CREATE_ANALYTICS_INSTANCE", "DELETE_ANALYTICS_INSTANCE", "START_ANALYTICS_INSTANCE", "STOP_ANALYTICS_INSTANCE", "SCALE_ANALYTICS_INSTANCE", "CHANGE_ANALYTICS_INSTANCE_COMPARTMENT", "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT"] + allowed_values = ["CREATE_ANALYTICS_INSTANCE", "DELETE_ANALYTICS_INSTANCE", "START_ANALYTICS_INSTANCE", "STOP_ANALYTICS_INSTANCE", "SCALE_ANALYTICS_INSTANCE", "CHANGE_ANALYTICS_INSTANCE_COMPARTMENT", "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT", "CREATE_VANITY_URL", "UPDATE_VANITY_URL", "DELETE_VANITY_URL", "CREATE_PRIVATE_ACCESS_CHANNEL", "UPDATE_PRIVATE_ACCESS_CHANNEL", "DELETE_PRIVATE_ACCESS_CHANNEL"] if not value_allowed_none_or_none_sentinel(operation_type, allowed_values): operation_type = 'UNKNOWN_ENUM_VALUE' self._operation_type = operation_type diff --git a/src/oci/analytics/models/work_request_resource.py b/src/oci/analytics/models/work_request_resource.py index 010939ef8f..6e2d81fdc4 100644 --- a/src/oci/analytics/models/work_request_resource.py +++ b/src/oci/analytics/models/work_request_resource.py @@ -41,6 +41,30 @@ class WorkRequestResource(object): #: This constant has a value of "NETWORK_ENDPOINT_CHANGED" ACTION_RESULT_NETWORK_ENDPOINT_CHANGED = "NETWORK_ENDPOINT_CHANGED" + #: A constant which can be used with the action_result property of a WorkRequestResource. + #: This constant has a value of "VANITY_URL_CREATED" + ACTION_RESULT_VANITY_URL_CREATED = "VANITY_URL_CREATED" + + #: A constant which can be used with the action_result property of a WorkRequestResource. + #: This constant has a value of "VANITY_URL_UPDATED" + ACTION_RESULT_VANITY_URL_UPDATED = "VANITY_URL_UPDATED" + + #: A constant which can be used with the action_result property of a WorkRequestResource. + #: This constant has a value of "VANITY_URL_DELETED" + ACTION_RESULT_VANITY_URL_DELETED = "VANITY_URL_DELETED" + + #: A constant which can be used with the action_result property of a WorkRequestResource. + #: This constant has a value of "PRIVATE_ACCESS_CHANNEL_CREATED" + ACTION_RESULT_PRIVATE_ACCESS_CHANNEL_CREATED = "PRIVATE_ACCESS_CHANNEL_CREATED" + + #: A constant which can be used with the action_result property of a WorkRequestResource. + #: This constant has a value of "PRIVATE_ACCESS_CHANNEL_UPDATED" + ACTION_RESULT_PRIVATE_ACCESS_CHANNEL_UPDATED = "PRIVATE_ACCESS_CHANNEL_UPDATED" + + #: A constant which can be used with the action_result property of a WorkRequestResource. + #: This constant has a value of "PRIVATE_ACCESS_CHANNEL_DELETED" + ACTION_RESULT_PRIVATE_ACCESS_CHANNEL_DELETED = "PRIVATE_ACCESS_CHANNEL_DELETED" + #: A constant which can be used with the action_result property of a WorkRequestResource. #: This constant has a value of "NONE" ACTION_RESULT_NONE = "NONE" @@ -56,7 +80,7 @@ def __init__(self, **kwargs): :param action_result: The value to assign to the action_result property of this WorkRequestResource. - Allowed values for this property are: "COMPARTMENT_CHANGED", "CREATED", "DELETED", "STARTED", "STOPPED", "SCALED", "NETWORK_ENDPOINT_CHANGED", "NONE", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "COMPARTMENT_CHANGED", "CREATED", "DELETED", "STARTED", "STOPPED", "SCALED", "NETWORK_ENDPOINT_CHANGED", "VANITY_URL_CREATED", "VANITY_URL_UPDATED", "VANITY_URL_DELETED", "PRIVATE_ACCESS_CHANNEL_CREATED", "PRIVATE_ACCESS_CHANNEL_UPDATED", "PRIVATE_ACCESS_CHANNEL_DELETED", "NONE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type action_result: str @@ -107,7 +131,7 @@ def action_result(self): **[Required]** Gets the action_result of this WorkRequestResource. The way in which this resource was affected by this work request. - Allowed values for this property are: "COMPARTMENT_CHANGED", "CREATED", "DELETED", "STARTED", "STOPPED", "SCALED", "NETWORK_ENDPOINT_CHANGED", "NONE", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "COMPARTMENT_CHANGED", "CREATED", "DELETED", "STARTED", "STOPPED", "SCALED", "NETWORK_ENDPOINT_CHANGED", "VANITY_URL_CREATED", "VANITY_URL_UPDATED", "VANITY_URL_DELETED", "PRIVATE_ACCESS_CHANNEL_CREATED", "PRIVATE_ACCESS_CHANNEL_UPDATED", "PRIVATE_ACCESS_CHANNEL_DELETED", "NONE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -126,7 +150,7 @@ def action_result(self, action_result): :param action_result: The action_result of this WorkRequestResource. :type: str """ - allowed_values = ["COMPARTMENT_CHANGED", "CREATED", "DELETED", "STARTED", "STOPPED", "SCALED", "NETWORK_ENDPOINT_CHANGED", "NONE"] + allowed_values = ["COMPARTMENT_CHANGED", "CREATED", "DELETED", "STARTED", "STOPPED", "SCALED", "NETWORK_ENDPOINT_CHANGED", "VANITY_URL_CREATED", "VANITY_URL_UPDATED", "VANITY_URL_DELETED", "PRIVATE_ACCESS_CHANNEL_CREATED", "PRIVATE_ACCESS_CHANNEL_UPDATED", "PRIVATE_ACCESS_CHANNEL_DELETED", "NONE"] if not value_allowed_none_or_none_sentinel(action_result, allowed_values): action_result = 'UNKNOWN_ENUM_VALUE' self._action_result = action_result diff --git a/src/oci/analytics/models/work_request_summary.py b/src/oci/analytics/models/work_request_summary.py index baf9c20a5b..c88ae53c60 100644 --- a/src/oci/analytics/models/work_request_summary.py +++ b/src/oci/analytics/models/work_request_summary.py @@ -41,6 +41,30 @@ class WorkRequestSummary(object): #: This constant has a value of "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT" OPERATION_TYPE_CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT = "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT" + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "CREATE_VANITY_URL" + OPERATION_TYPE_CREATE_VANITY_URL = "CREATE_VANITY_URL" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "UPDATE_VANITY_URL" + OPERATION_TYPE_UPDATE_VANITY_URL = "UPDATE_VANITY_URL" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "DELETE_VANITY_URL" + OPERATION_TYPE_DELETE_VANITY_URL = "DELETE_VANITY_URL" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "CREATE_PRIVATE_ACCESS_CHANNEL" + OPERATION_TYPE_CREATE_PRIVATE_ACCESS_CHANNEL = "CREATE_PRIVATE_ACCESS_CHANNEL" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "UPDATE_PRIVATE_ACCESS_CHANNEL" + OPERATION_TYPE_UPDATE_PRIVATE_ACCESS_CHANNEL = "UPDATE_PRIVATE_ACCESS_CHANNEL" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "DELETE_PRIVATE_ACCESS_CHANNEL" + OPERATION_TYPE_DELETE_PRIVATE_ACCESS_CHANNEL = "DELETE_PRIVATE_ACCESS_CHANNEL" + #: A constant which can be used with the status property of a WorkRequestSummary. #: This constant has a value of "ACCEPTED" STATUS_ACCEPTED = "ACCEPTED" @@ -76,7 +100,7 @@ def __init__(self, **kwargs): :param operation_type: The value to assign to the operation_type property of this WorkRequestSummary. - Allowed values for this property are: "CREATE_ANALYTICS_INSTANCE", "DELETE_ANALYTICS_INSTANCE", "START_ANALYTICS_INSTANCE", "STOP_ANALYTICS_INSTANCE", "SCALE_ANALYTICS_INSTANCE", "CHANGE_ANALYTICS_INSTANCE_COMPARTMENT", "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_ANALYTICS_INSTANCE", "DELETE_ANALYTICS_INSTANCE", "START_ANALYTICS_INSTANCE", "STOP_ANALYTICS_INSTANCE", "SCALE_ANALYTICS_INSTANCE", "CHANGE_ANALYTICS_INSTANCE_COMPARTMENT", "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT", "CREATE_VANITY_URL", "UPDATE_VANITY_URL", "DELETE_VANITY_URL", "CREATE_PRIVATE_ACCESS_CHANNEL", "UPDATE_PRIVATE_ACCESS_CHANNEL", "DELETE_PRIVATE_ACCESS_CHANNEL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type operation_type: str @@ -168,7 +192,7 @@ def operation_type(self): **[Required]** Gets the operation_type of this WorkRequestSummary. The operation performed by the work request. - Allowed values for this property are: "CREATE_ANALYTICS_INSTANCE", "DELETE_ANALYTICS_INSTANCE", "START_ANALYTICS_INSTANCE", "STOP_ANALYTICS_INSTANCE", "SCALE_ANALYTICS_INSTANCE", "CHANGE_ANALYTICS_INSTANCE_COMPARTMENT", "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_ANALYTICS_INSTANCE", "DELETE_ANALYTICS_INSTANCE", "START_ANALYTICS_INSTANCE", "STOP_ANALYTICS_INSTANCE", "SCALE_ANALYTICS_INSTANCE", "CHANGE_ANALYTICS_INSTANCE_COMPARTMENT", "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT", "CREATE_VANITY_URL", "UPDATE_VANITY_URL", "DELETE_VANITY_URL", "CREATE_PRIVATE_ACCESS_CHANNEL", "UPDATE_PRIVATE_ACCESS_CHANNEL", "DELETE_PRIVATE_ACCESS_CHANNEL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -187,7 +211,7 @@ def operation_type(self, operation_type): :param operation_type: The operation_type of this WorkRequestSummary. :type: str """ - allowed_values = ["CREATE_ANALYTICS_INSTANCE", "DELETE_ANALYTICS_INSTANCE", "START_ANALYTICS_INSTANCE", "STOP_ANALYTICS_INSTANCE", "SCALE_ANALYTICS_INSTANCE", "CHANGE_ANALYTICS_INSTANCE_COMPARTMENT", "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT"] + allowed_values = ["CREATE_ANALYTICS_INSTANCE", "DELETE_ANALYTICS_INSTANCE", "START_ANALYTICS_INSTANCE", "STOP_ANALYTICS_INSTANCE", "SCALE_ANALYTICS_INSTANCE", "CHANGE_ANALYTICS_INSTANCE_COMPARTMENT", "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT", "CREATE_VANITY_URL", "UPDATE_VANITY_URL", "DELETE_VANITY_URL", "CREATE_PRIVATE_ACCESS_CHANNEL", "UPDATE_PRIVATE_ACCESS_CHANNEL", "DELETE_PRIVATE_ACCESS_CHANNEL"] if not value_allowed_none_or_none_sentinel(operation_type, allowed_values): operation_type = 'UNKNOWN_ENUM_VALUE' self._operation_type = operation_type diff --git a/src/oci/blockchain/models/blockchain_platform.py b/src/oci/blockchain/models/blockchain_platform.py index 74dc102876..67b6e76a4c 100644 --- a/src/oci/blockchain/models/blockchain_platform.py +++ b/src/oci/blockchain/models/blockchain_platform.py @@ -53,6 +53,14 @@ class BlockchainPlatform(object): #: This constant has a value of "CUSTOM" PLATFORM_SHAPE_TYPE_CUSTOM = "CUSTOM" + #: A constant which can be used with the load_balancer_shape property of a BlockchainPlatform. + #: This constant has a value of "LB_100_MBPS" + LOAD_BALANCER_SHAPE_LB_100_MBPS = "LB_100_MBPS" + + #: A constant which can be used with the load_balancer_shape property of a BlockchainPlatform. + #: This constant has a value of "LB_400_MBPS" + LOAD_BALANCER_SHAPE_LB_400_MBPS = "LB_400_MBPS" + #: A constant which can be used with the lifecycle_state property of a BlockchainPlatform. #: This constant has a value of "CREATING" LIFECYCLE_STATE_CREATING = "CREATING" @@ -140,6 +148,12 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type platform_shape_type: str + :param load_balancer_shape: + The value to assign to the load_balancer_shape property of this BlockchainPlatform. + Allowed values for this property are: "LB_100_MBPS", "LB_400_MBPS", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type load_balancer_shape: str + :param service_endpoint: The value to assign to the service_endpoint property of this BlockchainPlatform. :type service_endpoint: str @@ -203,6 +217,7 @@ def __init__(self, **kwargs): 'platform_role': 'str', 'compute_shape': 'str', 'platform_shape_type': 'str', + 'load_balancer_shape': 'str', 'service_endpoint': 'str', 'lifecycle_state': 'str', 'lifecycle_details': 'str', @@ -229,6 +244,7 @@ def __init__(self, **kwargs): 'platform_role': 'platformRole', 'compute_shape': 'computeShape', 'platform_shape_type': 'platformShapeType', + 'load_balancer_shape': 'loadBalancerShape', 'service_endpoint': 'serviceEndpoint', 'lifecycle_state': 'lifecycleState', 'lifecycle_details': 'lifecycleDetails', @@ -254,6 +270,7 @@ def __init__(self, **kwargs): self._platform_role = None self._compute_shape = None self._platform_shape_type = None + self._load_balancer_shape = None self._service_endpoint = None self._lifecycle_state = None self._lifecycle_details = None @@ -549,6 +566,36 @@ def platform_shape_type(self, platform_shape_type): platform_shape_type = 'UNKNOWN_ENUM_VALUE' self._platform_shape_type = platform_shape_type + @property + def load_balancer_shape(self): + """ + Gets the load_balancer_shape of this BlockchainPlatform. + Type of Load Balancer shape - LB_100_MBPS or LB_400_MBPS. Default is LB_100_MBPS. + + Allowed values for this property are: "LB_100_MBPS", "LB_400_MBPS", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The load_balancer_shape of this BlockchainPlatform. + :rtype: str + """ + return self._load_balancer_shape + + @load_balancer_shape.setter + def load_balancer_shape(self, load_balancer_shape): + """ + Sets the load_balancer_shape of this BlockchainPlatform. + Type of Load Balancer shape - LB_100_MBPS or LB_400_MBPS. Default is LB_100_MBPS. + + + :param load_balancer_shape: The load_balancer_shape of this BlockchainPlatform. + :type: str + """ + allowed_values = ["LB_100_MBPS", "LB_400_MBPS"] + if not value_allowed_none_or_none_sentinel(load_balancer_shape, allowed_values): + load_balancer_shape = 'UNKNOWN_ENUM_VALUE' + self._load_balancer_shape = load_balancer_shape + @property def service_endpoint(self): """ diff --git a/src/oci/blockchain/models/create_blockchain_platform_details.py b/src/oci/blockchain/models/create_blockchain_platform_details.py index a074994d54..c5a89b46ec 100644 --- a/src/oci/blockchain/models/create_blockchain_platform_details.py +++ b/src/oci/blockchain/models/create_blockchain_platform_details.py @@ -250,7 +250,7 @@ def is_byol(self, is_byol): @property def idcs_access_token(self): """ - Gets the idcs_access_token of this CreateBlockchainPlatformDetails. + **[Required]** Gets the idcs_access_token of this CreateBlockchainPlatformDetails. IDCS access token with Identity Domain Administrator role diff --git a/src/oci/blockchain/models/update_blockchain_platform_details.py b/src/oci/blockchain/models/update_blockchain_platform_details.py index 4109b4fab6..a340dfcdb0 100644 --- a/src/oci/blockchain/models/update_blockchain_platform_details.py +++ b/src/oci/blockchain/models/update_blockchain_platform_details.py @@ -34,6 +34,10 @@ def __init__(self, **kwargs): The value to assign to the total_ocpu_capacity property of this UpdateBlockchainPlatformDetails. :type total_ocpu_capacity: int + :param load_balancer_shape: + The value to assign to the load_balancer_shape property of this UpdateBlockchainPlatformDetails. + :type load_balancer_shape: str + :param freeform_tags: The value to assign to the freeform_tags property of this UpdateBlockchainPlatformDetails. :type freeform_tags: dict(str, str) @@ -48,6 +52,7 @@ def __init__(self, **kwargs): 'storage_size_in_tbs': 'float', 'replicas': 'ReplicaDetails', 'total_ocpu_capacity': 'int', + 'load_balancer_shape': 'str', 'freeform_tags': 'dict(str, str)', 'defined_tags': 'dict(str, dict(str, object))' } @@ -57,6 +62,7 @@ def __init__(self, **kwargs): 'storage_size_in_tbs': 'storageSizeInTBs', 'replicas': 'replicas', 'total_ocpu_capacity': 'totalOcpuCapacity', + 'load_balancer_shape': 'loadBalancerShape', 'freeform_tags': 'freeformTags', 'defined_tags': 'definedTags' } @@ -65,6 +71,7 @@ def __init__(self, **kwargs): self._storage_size_in_tbs = None self._replicas = None self._total_ocpu_capacity = None + self._load_balancer_shape = None self._freeform_tags = None self._defined_tags = None @@ -160,6 +167,30 @@ def total_ocpu_capacity(self, total_ocpu_capacity): """ self._total_ocpu_capacity = total_ocpu_capacity + @property + def load_balancer_shape(self): + """ + Gets the load_balancer_shape of this UpdateBlockchainPlatformDetails. + Type of Load Balancer shape - LB_100_MBPS or LB_400_MBPS. Default is LB_100_MBPS. + + + :return: The load_balancer_shape of this UpdateBlockchainPlatformDetails. + :rtype: str + """ + return self._load_balancer_shape + + @load_balancer_shape.setter + def load_balancer_shape(self, load_balancer_shape): + """ + Sets the load_balancer_shape of this UpdateBlockchainPlatformDetails. + Type of Load Balancer shape - LB_100_MBPS or LB_400_MBPS. Default is LB_100_MBPS. + + + :param load_balancer_shape: The load_balancer_shape of this UpdateBlockchainPlatformDetails. + :type: str + """ + self._load_balancer_shape = load_balancer_shape + @property def freeform_tags(self): """ diff --git a/src/oci/core/compute_client.py b/src/oci/core/compute_client.py index d5eaa6eb03..2dccf1af9f 100644 --- a/src/oci/core/compute_client.py +++ b/src/oci/core/compute_client.py @@ -3301,8 +3301,17 @@ def instance_action(self, instance_id, action, **kwargs): - **SOFTRESET** - Gracefully reboots the instance by sending a shutdown command to the operating system, and then powers the instance back on. - For more information, see `Stopping and Starting an Instance`__. + - **SENDDIAGNOSTICINTERRUPT** - For advanced users. **Warning: Sending a diagnostic interrupt to a live system can + cause data corruption or system failure.** Sends a diagnostic interrupt that causes the instance's + OS to crash and then reboot. Before you send a diagnostic interrupt, you must configure the instance to generate a + crash dump file when it crashes. The crash dump captures information about the state of the OS at the time of + the crash. After the OS restarts, you can analyze the crash dump to diagnose the issue. For more information, see + `Sending a Diagnostic Interrupt`__. + For more information about managing instance lifecycle states, see + `Stopping and Starting an Instance`__. + + __ https://docs.cloud.oracle.com/Content/Compute/Tasks/sendingdiagnosticinterrupt.htm __ https://docs.cloud.oracle.com/Content/Compute/Tasks/restartinginstance.htm diff --git a/src/oci/core/models/add_public_ip_pool_capacity_details.py b/src/oci/core/models/add_public_ip_pool_capacity_details.py index 78bb97e49d..de08c8fb4e 100644 --- a/src/oci/core/models/add_public_ip_pool_capacity_details.py +++ b/src/oci/core/models/add_public_ip_pool_capacity_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class AddPublicIpPoolCapacityDetails(object): """ - The data to add capacity to a public ip pool + The information used to add capacity to an IP pool. """ def __init__(self, **kwargs): @@ -44,7 +44,9 @@ def __init__(self, **kwargs): def byoip_range_id(self): """ **[Required]** Gets the byoip_range_id of this AddPublicIpPoolCapacityDetails. - The OCID of the Byoip Range Id object to whch the cidr block belongs. + The `OCID`__ of the `ByoipRange` resource to which the CIDR block belongs. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The byoip_range_id of this AddPublicIpPoolCapacityDetails. @@ -56,7 +58,9 @@ def byoip_range_id(self): def byoip_range_id(self, byoip_range_id): """ Sets the byoip_range_id of this AddPublicIpPoolCapacityDetails. - The OCID of the Byoip Range Id object to whch the cidr block belongs. + The `OCID`__ of the `ByoipRange` resource to which the CIDR block belongs. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param byoip_range_id: The byoip_range_id of this AddPublicIpPoolCapacityDetails. @@ -68,7 +72,7 @@ def byoip_range_id(self, byoip_range_id): def cidr_block(self): """ **[Required]** Gets the cidr_block of this AddPublicIpPoolCapacityDetails. - The CIDR IP address range to be added to the Public Ip Pool + The CIDR block to add to the public IP pool. It could be all of the CIDR block identified in `byoipRangeId`, or a subrange. Example: `10.0.1.0/24` @@ -81,7 +85,7 @@ def cidr_block(self): def cidr_block(self, cidr_block): """ Sets the cidr_block of this AddPublicIpPoolCapacityDetails. - The CIDR IP address range to be added to the Public Ip Pool + The CIDR block to add to the public IP pool. It could be all of the CIDR block identified in `byoipRangeId`, or a subrange. Example: `10.0.1.0/24` diff --git a/src/oci/core/models/add_security_rule_details.py b/src/oci/core/models/add_security_rule_details.py index fe378467d1..c5c5e6b888 100644 --- a/src/oci/core/models/add_security_rule_details.py +++ b/src/oci/core/models/add_security_rule_details.py @@ -310,20 +310,6 @@ def direction(self, direction): def icmp_options(self): """ Gets the icmp_options of this AddSecurityRuleDetails. - Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code - as defined in: - - `ICMP Parameters`__ - - `ICMPv6 Parameters`__ - - If you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and - codes are allowed. If you do provide this object, the type is required and the code is optional. - To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 (\"Destination - Unreachable\") code 4 (\"Fragmentation Needed and Don't Fragment was Set\"). If you need to specify - multiple codes for a single type, create a separate security list rule for each. - - __ http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml - __ https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml - :return: The icmp_options of this AddSecurityRuleDetails. :rtype: oci.core.models.IcmpOptions @@ -334,20 +320,6 @@ def icmp_options(self): def icmp_options(self, icmp_options): """ Sets the icmp_options of this AddSecurityRuleDetails. - Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code - as defined in: - - `ICMP Parameters`__ - - `ICMPv6 Parameters`__ - - If you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and - codes are allowed. If you do provide this object, the type is required and the code is optional. - To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 (\"Destination - Unreachable\") code 4 (\"Fragmentation Needed and Don't Fragment was Set\"). If you need to specify - multiple codes for a single type, create a separate security list rule for each. - - __ http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml - __ https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml - :param icmp_options: The icmp_options of this AddSecurityRuleDetails. :type: oci.core.models.IcmpOptions @@ -532,9 +504,6 @@ def source_type(self, source_type): def tcp_options(self): """ Gets the tcp_options of this AddSecurityRuleDetails. - Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. - If you specify TCP as the protocol but omit this object, then all destination ports are allowed. - :return: The tcp_options of this AddSecurityRuleDetails. :rtype: oci.core.models.TcpOptions @@ -545,9 +514,6 @@ def tcp_options(self): def tcp_options(self, tcp_options): """ Sets the tcp_options of this AddSecurityRuleDetails. - Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. - If you specify TCP as the protocol but omit this object, then all destination ports are allowed. - :param tcp_options: The tcp_options of this AddSecurityRuleDetails. :type: oci.core.models.TcpOptions @@ -558,9 +524,6 @@ def tcp_options(self, tcp_options): def udp_options(self): """ Gets the udp_options of this AddSecurityRuleDetails. - Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. - If you specify UDP as the protocol but omit this object, then all destination ports are allowed. - :return: The udp_options of this AddSecurityRuleDetails. :rtype: oci.core.models.UdpOptions @@ -571,9 +534,6 @@ def udp_options(self): def udp_options(self, udp_options): """ Sets the udp_options of this AddSecurityRuleDetails. - Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. - If you specify UDP as the protocol but omit this object, then all destination ports are allowed. - :param udp_options: The udp_options of this AddSecurityRuleDetails. :type: oci.core.models.UdpOptions diff --git a/src/oci/core/models/add_vcn_cidr_details.py b/src/oci/core/models/add_vcn_cidr_details.py index 1c51ad6541..f84ecdf469 100644 --- a/src/oci/core/models/add_vcn_cidr_details.py +++ b/src/oci/core/models/add_vcn_cidr_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class AddVcnCidrDetails(object): """ - Contains a new CIDR which will be added to the VCN. + Details for adding a CIDR block to a VCN. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def cidr_block(self): """ **[Required]** Gets the cidr_block of this AddVcnCidrDetails. - The CIDR IP address that needs to be added. + The CIDR block to add. :return: The cidr_block of this AddVcnCidrDetails. @@ -49,7 +49,7 @@ def cidr_block(self): def cidr_block(self, cidr_block): """ Sets the cidr_block of this AddVcnCidrDetails. - The CIDR IP address that needs to be added. + The CIDR block to add. :param cidr_block: The cidr_block of this AddVcnCidrDetails. diff --git a/src/oci/core/models/attach_vnic_details.py b/src/oci/core/models/attach_vnic_details.py index 697632193b..877d18be69 100644 --- a/src/oci/core/models/attach_vnic_details.py +++ b/src/oci/core/models/attach_vnic_details.py @@ -58,8 +58,6 @@ def __init__(self, **kwargs): def create_vnic_details(self): """ **[Required]** Gets the create_vnic_details of this AttachVnicDetails. - Details for creating a new VNIC. - :return: The create_vnic_details of this AttachVnicDetails. :rtype: oci.core.models.CreateVnicDetails @@ -70,8 +68,6 @@ def create_vnic_details(self): def create_vnic_details(self, create_vnic_details): """ Sets the create_vnic_details of this AttachVnicDetails. - Details for creating a new VNIC. - :param create_vnic_details: The create_vnic_details of this AttachVnicDetails. :type: oci.core.models.CreateVnicDetails diff --git a/src/oci/core/models/boot_volume.py b/src/oci/core/models/boot_volume.py index 26cf880dcf..e3fd6a48e4 100644 --- a/src/oci/core/models/boot_volume.py +++ b/src/oci/core/models/boot_volume.py @@ -568,9 +568,6 @@ 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. - If null, this means that the boot volume was created from an image. - :return: The source_details of this BootVolume. :rtype: oci.core.models.BootVolumeSourceDetails @@ -581,9 +578,6 @@ 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. - If null, this means that the boot volume was created from an image. - :param source_details: The source_details of this BootVolume. :type: oci.core.models.BootVolumeSourceDetails diff --git a/src/oci/core/models/byoip_allocated_range_collection.py b/src/oci/core/models/byoip_allocated_range_collection.py index b3d8a2b10c..2f39f5cfd6 100644 --- a/src/oci/core/models/byoip_allocated_range_collection.py +++ b/src/oci/core/models/byoip_allocated_range_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class ByoipAllocatedRangeCollection(object): """ - Results of a ListByoipAllocatedRanges operation. + Results of a `ListByoipAllocatedRanges` operation. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this ByoipAllocatedRangeCollection. - list of Byoip allocated ranges as part of public IP pool + A list of subranges of a BYOIP CIDR block allocated to an IP pool. :return: The items of this ByoipAllocatedRangeCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this ByoipAllocatedRangeCollection. - list of Byoip allocated ranges as part of public IP pool + A list of subranges of a BYOIP CIDR block allocated to an IP pool. :param items: The items of this ByoipAllocatedRangeCollection. diff --git a/src/oci/core/models/byoip_allocated_range_summary.py b/src/oci/core/models/byoip_allocated_range_summary.py index 17b313150c..0783865fd5 100644 --- a/src/oci/core/models/byoip_allocated_range_summary.py +++ b/src/oci/core/models/byoip_allocated_range_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class ByoipAllocatedRangeSummary(object): """ - Subrange of ByoipRange which is allocated to a PublicIpPool + A summary of CIDR block subranges that are currently allocated to an IP pool. """ def __init__(self, **kwargs): @@ -44,7 +44,7 @@ def __init__(self, **kwargs): def cidr_block(self): """ Gets the cidr_block of this ByoipAllocatedRangeSummary. - The address range part of the ByoipRange which is used for a publicIpPool. + The BYOIP CIDR block range or subrange allocated to an IP pool. This could be all or part of a BYOIP CIDR block. :return: The cidr_block of this ByoipAllocatedRangeSummary. @@ -56,7 +56,7 @@ def cidr_block(self): def cidr_block(self, cidr_block): """ Sets the cidr_block of this ByoipAllocatedRangeSummary. - The address range part of the ByoipRange which is used for a publicIpPool. + The BYOIP CIDR block range or subrange allocated to an IP pool. This could be all or part of a BYOIP CIDR block. :param cidr_block: The cidr_block of this ByoipAllocatedRangeSummary. @@ -68,7 +68,9 @@ def cidr_block(self, cidr_block): def public_ip_pool_id(self): """ Gets the public_ip_pool_id of this ByoipAllocatedRangeSummary. - The OCID of the PublicIpPool containing the part of the Byoip range. + The `OCID`__ of the IP pool containing the CIDR block. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The public_ip_pool_id of this ByoipAllocatedRangeSummary. @@ -80,7 +82,9 @@ def public_ip_pool_id(self): def public_ip_pool_id(self, public_ip_pool_id): """ Sets the public_ip_pool_id of this ByoipAllocatedRangeSummary. - The OCID of the PublicIpPool containing the part of the Byoip range. + The `OCID`__ of the IP pool containing the CIDR block. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param public_ip_pool_id: The public_ip_pool_id of this ByoipAllocatedRangeSummary. diff --git a/src/oci/core/models/byoip_range.py b/src/oci/core/models/byoip_range.py index 9363f59b36..7dacdbca1d 100644 --- a/src/oci/core/models/byoip_range.py +++ b/src/oci/core/models/byoip_range.py @@ -10,7 +10,10 @@ @init_model_state_from_kwargs class ByoipRange(object): """ - A ByoipRange, is an IP address prefix that the user owns and wishes to import into OCI. + Oracle offers the ability to Bring Your Own IP (BYOIP), importing public IP addresses that you currently own to Oracle Cloud Infrastructure. A `ByoipRange` resource is a record of the imported address block (a BYOIP CIDR block) and also some associated metadata. + The process used to `Bring Your Own IP`__ is explained in the documentation. + + __ https://docs.cloud.oracle.com/Content/Network/Concepts/BYOIP.htm """ #: A constant which can be used with the lifecycle_details property of a ByoipRange. @@ -41,6 +44,14 @@ class ByoipRange(object): #: This constant has a value of "DELETED" LIFECYCLE_DETAILS_DELETED = "DELETED" + #: A constant which can be used with the lifecycle_details property of a ByoipRange. + #: This constant has a value of "ADVERTISING" + LIFECYCLE_DETAILS_ADVERTISING = "ADVERTISING" + + #: A constant which can be used with the lifecycle_details property of a ByoipRange. + #: This constant has a value of "WITHDRAWING" + LIFECYCLE_DETAILS_WITHDRAWING = "WITHDRAWING" + #: A constant which can be used with the lifecycle_state property of a ByoipRange. #: This constant has a value of "INACTIVE" LIFECYCLE_STATE_INACTIVE = "INACTIVE" @@ -92,7 +103,7 @@ def __init__(self, **kwargs): :param lifecycle_details: The value to assign to the lifecycle_details property of this ByoipRange. - Allowed values for this property are: "CREATING", "VALIDATING", "PROVISIONED", "ACTIVE", "FAILED", "DELETING", "DELETED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATING", "VALIDATING", "PROVISIONED", "ACTIVE", "FAILED", "DELETING", "DELETED", "ADVERTISING", "WITHDRAWING", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_details: str @@ -173,7 +184,7 @@ def __init__(self, **kwargs): def cidr_block(self): """ **[Required]** Gets the cidr_block of this ByoipRange. - The address range the user is on-boarding. + The public IPv4 CIDR block being imported from on-premises to the Oracle cloud. :return: The cidr_block of this ByoipRange. @@ -185,7 +196,7 @@ def cidr_block(self): def cidr_block(self, cidr_block): """ Sets the cidr_block of this ByoipRange. - The address range the user is on-boarding. + The public IPv4 CIDR block being imported from on-premises to the Oracle cloud. :param cidr_block: The cidr_block of this ByoipRange. @@ -197,7 +208,9 @@ def cidr_block(self, cidr_block): def compartment_id(self): """ **[Required]** Gets the compartment_id of this ByoipRange. - The OCID of the compartment containing the Byoip Range. + The `OCID`__ of the compartment containing the BYOIP CIDR block. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this ByoipRange. @@ -209,7 +222,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this ByoipRange. - The OCID of the compartment containing the Byoip Range. + The `OCID`__ of the compartment containing the BYOIP CIDR block. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this ByoipRange. @@ -315,7 +330,9 @@ def freeform_tags(self, freeform_tags): def id(self): """ **[Required]** Gets the id of this ByoipRange. - The Oracle ID (OCID) of the Byoip Range. + The `OCID`__ of the `ByoipRange` resource. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The id of this ByoipRange. @@ -327,7 +344,9 @@ def id(self): def id(self, id): """ Sets the id of this ByoipRange. - The Oracle ID (OCID) of the Byoip Range. + The `OCID`__ of the `ByoipRange` resource. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param id: The id of this ByoipRange. @@ -339,9 +358,9 @@ def id(self, id): def lifecycle_details(self): """ Gets the lifecycle_details of this ByoipRange. - The Byoip Range's current substate. + The `ByoipRange` resource's current status. - Allowed values for this property are: "CREATING", "VALIDATING", "PROVISIONED", "ACTIVE", "FAILED", "DELETING", "DELETED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATING", "VALIDATING", "PROVISIONED", "ACTIVE", "FAILED", "DELETING", "DELETED", "ADVERTISING", "WITHDRAWING", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -354,13 +373,13 @@ def lifecycle_details(self): def lifecycle_details(self, lifecycle_details): """ Sets the lifecycle_details of this ByoipRange. - The Byoip Range's current substate. + The `ByoipRange` resource's current status. :param lifecycle_details: The lifecycle_details of this ByoipRange. :type: str """ - allowed_values = ["CREATING", "VALIDATING", "PROVISIONED", "ACTIVE", "FAILED", "DELETING", "DELETED"] + allowed_values = ["CREATING", "VALIDATING", "PROVISIONED", "ACTIVE", "FAILED", "DELETING", "DELETED", "ADVERTISING", "WITHDRAWING"] if not value_allowed_none_or_none_sentinel(lifecycle_details, allowed_values): lifecycle_details = 'UNKNOWN_ENUM_VALUE' self._lifecycle_details = lifecycle_details @@ -369,7 +388,7 @@ def lifecycle_details(self, lifecycle_details): def lifecycle_state(self): """ **[Required]** Gets the lifecycle_state of this ByoipRange. - The Byoip Range's current state. + The `ByoipRange` resource's current state. Allowed values for this property are: "INACTIVE", "UPDATING", "ACTIVE", "DELETING", "DELETED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -384,7 +403,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this ByoipRange. - The Byoip Range's current state. + The `ByoipRange` resource's current state. :param lifecycle_state: The lifecycle_state of this ByoipRange. @@ -399,7 +418,7 @@ def lifecycle_state(self, lifecycle_state): def time_created(self): """ **[Required]** Gets the time_created of this ByoipRange. - The date and time the Byoip Range was created, in the format defined by `RFC3339`__. + The date and time the `ByoipRange` resource was created, in the format defined by `RFC3339`__. Example: `2016-08-25T21:10:29.600Z` @@ -415,7 +434,7 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this ByoipRange. - The date and time the Byoip Range was created, in the format defined by `RFC3339`__. + The date and time the `ByoipRange` resource was created, in the format defined by `RFC3339`__. Example: `2016-08-25T21:10:29.600Z` @@ -431,7 +450,7 @@ def time_created(self, time_created): def time_validated(self): """ Gets the time_validated of this ByoipRange. - The date and time the Byoip Range was validated, in the format defined by `RFC3339`__. + The date and time the `ByoipRange` resource was validated, in the format defined by `RFC3339`__. Example: `2016-08-25T21:10:29.600Z` @@ -447,7 +466,7 @@ def time_validated(self): def time_validated(self, time_validated): """ Sets the time_validated of this ByoipRange. - The date and time the Byoip Range was validated, in the format defined by `RFC3339`__. + The date and time the `ByoipRange` resource was validated, in the format defined by `RFC3339`__. Example: `2016-08-25T21:10:29.600Z` @@ -463,7 +482,7 @@ def time_validated(self, time_validated): def time_advertised(self): """ Gets the time_advertised of this ByoipRange. - The date and time the Byoip Range was advertised, in the format defined by `RFC3339`__. + The date and time the `ByoipRange` resource was advertised to the internet by BGP, in the format defined by `RFC3339`__. Example: `2016-08-25T21:10:29.600Z` @@ -479,7 +498,7 @@ def time_advertised(self): def time_advertised(self, time_advertised): """ Sets the time_advertised of this ByoipRange. - The date and time the Byoip Range was advertised, in the format defined by `RFC3339`__. + The date and time the `ByoipRange` resource was advertised to the internet by BGP, in the format defined by `RFC3339`__. Example: `2016-08-25T21:10:29.600Z` @@ -495,7 +514,7 @@ def time_advertised(self, time_advertised): def time_withdrawn(self): """ Gets the time_withdrawn of this ByoipRange. - The date and time the Byoip Range was withdrawn, in the format defined by `RFC3339`__. + The date and time the `ByoipRange` resource was withdrawn from advertisement by BGP to the internet, in the format defined by `RFC3339`__. Example: `2016-08-25T21:10:29.600Z` @@ -511,7 +530,7 @@ def time_withdrawn(self): def time_withdrawn(self, time_withdrawn): """ Sets the time_withdrawn of this ByoipRange. - The date and time the Byoip Range was withdrawn, in the format defined by `RFC3339`__. + The date and time the `ByoipRange` resource was withdrawn from advertisement by BGP to the internet, in the format defined by `RFC3339`__. Example: `2016-08-25T21:10:29.600Z` @@ -527,7 +546,9 @@ def time_withdrawn(self, time_withdrawn): def validation_token(self): """ **[Required]** Gets the validation_token of this ByoipRange. - This is an internally generated ASCII string that the user will then use as part of the validation process. Specifically, they will need to add the token string generated by the service to their Internet Registry record. + The validation token is an internally-generated ASCII string used in the validation process. See `Importing a CIDR block`__ for details. + + __ https://docs.cloud.oracle.com/Content/Network/Concepts/BYOIP.htm#import_cidr :return: The validation_token of this ByoipRange. @@ -539,7 +560,9 @@ def validation_token(self): def validation_token(self, validation_token): """ Sets the validation_token of this ByoipRange. - This is an internally generated ASCII string that the user will then use as part of the validation process. Specifically, they will need to add the token string generated by the service to their Internet Registry record. + The validation token is an internally-generated ASCII string used in the validation process. See `Importing a CIDR block`__ for details. + + __ https://docs.cloud.oracle.com/Content/Network/Concepts/BYOIP.htm#import_cidr :param validation_token: The validation_token of this ByoipRange. diff --git a/src/oci/core/models/byoip_range_collection.py b/src/oci/core/models/byoip_range_collection.py index c692d40473..f6833a3944 100644 --- a/src/oci/core/models/byoip_range_collection.py +++ b/src/oci/core/models/byoip_range_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class ByoipRangeCollection(object): """ - Results of a ListByoipRange operation. + The results returned by a `ListByoipRange` operation. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this ByoipRangeCollection. - list of Byoip Range object summaries + A list of `ByoipRange` resource summaries. :return: The items of this ByoipRangeCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this ByoipRangeCollection. - list of Byoip Range object summaries + A list of `ByoipRange` resource summaries. :param items: The items of this ByoipRangeCollection. diff --git a/src/oci/core/models/byoip_range_summary.py b/src/oci/core/models/byoip_range_summary.py index 9ef692bb51..e496c78373 100644 --- a/src/oci/core/models/byoip_range_summary.py +++ b/src/oci/core/models/byoip_range_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class ByoipRangeSummary(object): """ - Summary information about a ByoipRange + Information about a `ByoipRange` resource. """ def __init__(self, **kwargs): @@ -93,7 +93,7 @@ def __init__(self, **kwargs): def cidr_block(self): """ Gets the cidr_block of this ByoipRangeSummary. - The address range the user is on-boarding. + The public IPv4 address range you are importing to the Oracle cloud. :return: The cidr_block of this ByoipRangeSummary. @@ -105,7 +105,7 @@ def cidr_block(self): def cidr_block(self, cidr_block): """ Sets the cidr_block of this ByoipRangeSummary. - The address range the user is on-boarding. + The public IPv4 address range you are importing to the Oracle cloud. :param cidr_block: The cidr_block of this ByoipRangeSummary. @@ -117,7 +117,9 @@ def cidr_block(self, cidr_block): def compartment_id(self): """ Gets the compartment_id of this ByoipRangeSummary. - The OCID of the compartment containing the Byoip Range. + The `OCID`__ of the compartment containing the `ByoipRange` resource. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this ByoipRangeSummary. @@ -129,7 +131,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this ByoipRangeSummary. - The OCID of the compartment containing the Byoip Range. + The `OCID`__ of the compartment containing the `ByoipRange` resource. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this ByoipRangeSummary. @@ -235,7 +239,9 @@ def freeform_tags(self, freeform_tags): def id(self): """ Gets the id of this ByoipRangeSummary. - The Oracle ID (OCID) of the Byoip Range. + The `OCID`__ of the `ByoipRange` resource. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The id of this ByoipRangeSummary. @@ -247,7 +253,9 @@ def id(self): def id(self, id): """ Sets the id of this ByoipRangeSummary. - The Oracle ID (OCID) of the Byoip Range. + The `OCID`__ of the `ByoipRange` resource. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param id: The id of this ByoipRangeSummary. @@ -259,7 +267,7 @@ def id(self, id): def lifecycle_state(self): """ Gets the lifecycle_state of this ByoipRangeSummary. - The Byoip Range's current state. + The `ByoipRange` resource's current state. :return: The lifecycle_state of this ByoipRangeSummary. @@ -271,7 +279,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this ByoipRangeSummary. - The Byoip Range's current state. + The `ByoipRange` resource's current state. :param lifecycle_state: The lifecycle_state of this ByoipRangeSummary. @@ -307,7 +315,7 @@ def lifecycle_details(self, lifecycle_details): def time_created(self): """ Gets the time_created of this ByoipRangeSummary. - The date and time the Byoip Range was created, in the format defined by `RFC3339`__. + The date and time the `ByoipRange` resource was created, in the format defined by `RFC3339`__. Example: `2016-08-25T21:10:29.600Z` @@ -323,7 +331,7 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this ByoipRangeSummary. - The date and time the Byoip Range was created, in the format defined by `RFC3339`__. + The date and time the `ByoipRange` resource was created, in the format defined by `RFC3339`__. Example: `2016-08-25T21:10:29.600Z` diff --git a/src/oci/core/models/change_byoip_range_compartment_details.py b/src/oci/core/models/change_byoip_range_compartment_details.py index 3c243615dc..d003cfef5e 100644 --- a/src/oci/core/models/change_byoip_range_compartment_details.py +++ b/src/oci/core/models/change_byoip_range_compartment_details.py @@ -37,8 +37,7 @@ def __init__(self, **kwargs): def compartment_id(self): """ **[Required]** Gets the compartment_id of this ChangeByoipRangeCompartmentDetails. - The `OCID`__ of the compartment to move the - Byoip Range to. + The `OCID`__ of the destination compartment for the BYOIP CIDR block move. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm @@ -52,8 +51,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this ChangeByoipRangeCompartmentDetails. - The `OCID`__ of the compartment to move the - Byoip Range to. + The `OCID`__ of the destination compartment for the BYOIP CIDR block move. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm diff --git a/src/oci/core/models/change_public_ip_pool_compartment_details.py b/src/oci/core/models/change_public_ip_pool_compartment_details.py index 0e67057a21..2d24bd90ea 100644 --- a/src/oci/core/models/change_public_ip_pool_compartment_details.py +++ b/src/oci/core/models/change_public_ip_pool_compartment_details.py @@ -37,8 +37,7 @@ def __init__(self, **kwargs): def compartment_id(self): """ **[Required]** Gets the compartment_id of this ChangePublicIpPoolCompartmentDetails. - The `OCID`__ of the compartment to move the - Public IP Pool to. + The `OCID`__ of the destination compartment for the public IP pool move. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm @@ -52,8 +51,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this ChangePublicIpPoolCompartmentDetails. - The `OCID`__ of the compartment to move the - Public IP Pool to. + The `OCID`__ of the destination compartment for the public IP pool move. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm diff --git a/src/oci/core/models/cluster_network.py b/src/oci/core/models/cluster_network.py index 6c9b8a774b..0be1a799f8 100644 --- a/src/oci/core/models/cluster_network.py +++ b/src/oci/core/models/cluster_network.py @@ -314,8 +314,6 @@ def instance_pools(self, instance_pools): def placement_configuration(self): """ Gets the placement_configuration of this ClusterNetwork. - The placement configuration for the instance pools in the cluster network. - :return: The placement_configuration of this ClusterNetwork. :rtype: oci.core.models.ClusterNetworkPlacementConfigurationDetails @@ -326,8 +324,6 @@ def placement_configuration(self): def placement_configuration(self, placement_configuration): """ Sets the placement_configuration of this ClusterNetwork. - The placement configuration for the instance pools in the cluster network. - :param placement_configuration: The placement_configuration of this ClusterNetwork. :type: oci.core.models.ClusterNetworkPlacementConfigurationDetails diff --git a/src/oci/core/models/cpe_device_shape_detail.py b/src/oci/core/models/cpe_device_shape_detail.py index 2c8477f7c3..1b3de52a04 100644 --- a/src/oci/core/models/cpe_device_shape_detail.py +++ b/src/oci/core/models/cpe_device_shape_detail.py @@ -89,8 +89,6 @@ def cpe_device_shape_id(self, cpe_device_shape_id): def cpe_device_info(self): """ Gets the cpe_device_info of this CpeDeviceShapeDetail. - Basic information about this particular CPE device type. - :return: The cpe_device_info of this CpeDeviceShapeDetail. :rtype: oci.core.models.CpeDeviceInfo @@ -101,8 +99,6 @@ def cpe_device_info(self): def cpe_device_info(self, cpe_device_info): """ Sets the cpe_device_info of this CpeDeviceShapeDetail. - Basic information about this particular CPE device type. - :param cpe_device_info: The cpe_device_info of this CpeDeviceShapeDetail. :type: oci.core.models.CpeDeviceInfo diff --git a/src/oci/core/models/cpe_device_shape_summary.py b/src/oci/core/models/cpe_device_shape_summary.py index 85fb2d6a73..d2c6f734a7 100644 --- a/src/oci/core/models/cpe_device_shape_summary.py +++ b/src/oci/core/models/cpe_device_shape_summary.py @@ -75,8 +75,6 @@ def id(self, id): def cpe_device_info(self): """ Gets the cpe_device_info of this CpeDeviceShapeSummary. - Basic information about this particular CPE device type. - :return: The cpe_device_info of this CpeDeviceShapeSummary. :rtype: oci.core.models.CpeDeviceInfo @@ -87,8 +85,6 @@ def cpe_device_info(self): def cpe_device_info(self, cpe_device_info): """ Sets the cpe_device_info of this CpeDeviceShapeSummary. - Basic information about this particular CPE device type. - :param cpe_device_info: The cpe_device_info of this CpeDeviceShapeSummary. :type: oci.core.models.CpeDeviceInfo diff --git a/src/oci/core/models/create_boot_volume_details.py b/src/oci/core/models/create_boot_volume_details.py index e28fdc5ab6..ff2d7390c8 100644 --- a/src/oci/core/models/create_boot_volume_details.py +++ b/src/oci/core/models/create_boot_volume_details.py @@ -373,9 +373,6 @@ def vpus_per_gb(self, vpus_per_gb): 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. - This is a mandatory field for a boot volume. - :return: The source_details of this CreateBootVolumeDetails. :rtype: oci.core.models.BootVolumeSourceDetails @@ -386,9 +383,6 @@ 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. - This is a mandatory field for a boot volume. - :param source_details: The source_details of this CreateBootVolumeDetails. :type: oci.core.models.BootVolumeSourceDetails diff --git a/src/oci/core/models/create_byoip_range_details.py b/src/oci/core/models/create_byoip_range_details.py index 5f5aa30783..5e2093f842 100644 --- a/src/oci/core/models/create_byoip_range_details.py +++ b/src/oci/core/models/create_byoip_range_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateByoipRangeDetails(object): """ - The data to create a Byoip Range + The information used to create a `ByoipRange` resource. """ def __init__(self, **kwargs): @@ -65,7 +65,7 @@ def __init__(self, **kwargs): def cidr_block(self): """ **[Required]** Gets the cidr_block of this CreateByoipRangeDetails. - The CIDR IP address range of the prefix. + The BYOIP CIDR block. You can assign some or all of it to a public IP pool after it is validated. Example: `10.0.1.0/24` @@ -78,7 +78,7 @@ def cidr_block(self): def cidr_block(self, cidr_block): """ Sets the cidr_block of this CreateByoipRangeDetails. - The CIDR IP address range of the prefix. + The BYOIP CIDR block. You can assign some or all of it to a public IP pool after it is validated. Example: `10.0.1.0/24` @@ -91,7 +91,9 @@ def cidr_block(self, cidr_block): def compartment_id(self): """ **[Required]** Gets the compartment_id of this CreateByoipRangeDetails. - The OCID of the compartment to contain the Byoip Range. + The `OCID`__ of the compartment containing the BYOIP CIDR block. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this CreateByoipRangeDetails. @@ -103,7 +105,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this CreateByoipRangeDetails. - The OCID of the compartment to contain the Byoip Range. + The `OCID`__ of the compartment containing the BYOIP CIDR block. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this CreateByoipRangeDetails. diff --git a/src/oci/core/models/create_cluster_network_details.py b/src/oci/core/models/create_cluster_network_details.py index 75fde1f520..e144e95d16 100644 --- a/src/oci/core/models/create_cluster_network_details.py +++ b/src/oci/core/models/create_cluster_network_details.py @@ -224,8 +224,6 @@ def instance_pools(self, instance_pools): def placement_configuration(self): """ **[Required]** Gets the placement_configuration of this CreateClusterNetworkDetails. - The placement configuration for the instance pools in the cluster network. - :return: The placement_configuration of this CreateClusterNetworkDetails. :rtype: oci.core.models.ClusterNetworkPlacementConfigurationDetails @@ -236,8 +234,6 @@ def placement_configuration(self): def placement_configuration(self, placement_configuration): """ Sets the placement_configuration of this CreateClusterNetworkDetails. - The placement configuration for the instance pools in the cluster network. - :param placement_configuration: The placement_configuration of this CreateClusterNetworkDetails. :type: oci.core.models.ClusterNetworkPlacementConfigurationDetails diff --git a/src/oci/core/models/create_drg_attachment_details.py b/src/oci/core/models/create_drg_attachment_details.py index 38a6ba244c..3bfa7d75c6 100644 --- a/src/oci/core/models/create_drg_attachment_details.py +++ b/src/oci/core/models/create_drg_attachment_details.py @@ -111,7 +111,6 @@ def route_table_id(self): If you don't specify a route table here, the DRG attachment is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the DRG attachment. - For information about why you would associate a route table with a DRG attachment, see: * `Transit Routing: Access to Multiple VCNs in Same Region`__ @@ -135,7 +134,6 @@ def route_table_id(self, route_table_id): If you don't specify a route table here, the DRG attachment is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the DRG attachment. - For information about why you would associate a route table with a DRG attachment, see: * `Transit Routing: Access to Multiple VCNs in Same Region`__ diff --git a/src/oci/core/models/create_image_details.py b/src/oci/core/models/create_image_details.py index 40ee2763dd..df65bb6b0f 100644 --- a/src/oci/core/models/create_image_details.py +++ b/src/oci/core/models/create_image_details.py @@ -222,8 +222,6 @@ def freeform_tags(self, freeform_tags): def image_source_details(self): """ Gets the image_source_details of this CreateImageDetails. - Details for creating an image through import - :return: The image_source_details of this CreateImageDetails. :rtype: oci.core.models.ImageSourceDetails @@ -234,8 +232,6 @@ def image_source_details(self): def image_source_details(self, image_source_details): """ Sets the image_source_details of this CreateImageDetails. - Details for creating an image through import - :param image_source_details: The image_source_details of this CreateImageDetails. :type: oci.core.models.ImageSourceDetails diff --git a/src/oci/core/models/create_instance_configuration_base.py b/src/oci/core/models/create_instance_configuration_base.py index 3e6a3f59bb..10cfe410d0 100644 --- a/src/oci/core/models/create_instance_configuration_base.py +++ b/src/oci/core/models/create_instance_configuration_base.py @@ -224,12 +224,28 @@ def source(self): such as the base image, shape, and metadata. You can also specify the associated resources for the instance, such as block volume attachments and network configuration. + When you create an instance configuration using an existing instance as a template, the instance + configuration does not include any information from the source instance's boot volume, such as installed + applications, binaries, and files on the instance. It also does not include the contents of + any block volumes that are attached to the instance. + + To create an instance configuration that includes the custom setup from an instance's boot volume, you + must first create a custom image from the instance (see :func:`create_image`). + Then, use the custom image to launch a new instance + (see :func:`launch_instance`). Finally, create the instance + configuration based on the instance that you created from the custom image. + + To include block volume contents with an instance configuration, first create a backup of the attached block volumes + (see :func:`create_volume_backup`). Then, create the instance + configuration by specifying the list of settings, using + :func:`instance_configuration_volume_source_from_volume_backup_details` + to include the block volume backups in the list of settings. + The following values are supported: * `NONE`: Creates an instance configuration using the list of settings that you specify. - * `INSTANCE`: Creates an instance configuration using an existing instance as a template. The - instance configuration uses the same settings as the instance. + * `INSTANCE`: Creates an instance configuration using an existing instance as a template. Allowed values for this property are: "NONE", "INSTANCE" @@ -248,12 +264,28 @@ def source(self, source): such as the base image, shape, and metadata. You can also specify the associated resources for the instance, such as block volume attachments and network configuration. + When you create an instance configuration using an existing instance as a template, the instance + configuration does not include any information from the source instance's boot volume, such as installed + applications, binaries, and files on the instance. It also does not include the contents of + any block volumes that are attached to the instance. + + To create an instance configuration that includes the custom setup from an instance's boot volume, you + must first create a custom image from the instance (see :func:`create_image`). + Then, use the custom image to launch a new instance + (see :func:`launch_instance`). Finally, create the instance + configuration based on the instance that you created from the custom image. + + To include block volume contents with an instance configuration, first create a backup of the attached block volumes + (see :func:`create_volume_backup`). Then, create the instance + configuration by specifying the list of settings, using + :func:`instance_configuration_volume_source_from_volume_backup_details` + to include the block volume backups in the list of settings. + The following values are supported: * `NONE`: Creates an instance configuration using the list of settings that you specify. - * `INSTANCE`: Creates an instance configuration using an existing instance as a template. The - instance configuration uses the same settings as the instance. + * `INSTANCE`: Creates an instance configuration using an existing instance as a template. :param source: The source of this CreateInstanceConfigurationBase. diff --git a/src/oci/core/models/create_ip_sec_connection_tunnel_details.py b/src/oci/core/models/create_ip_sec_connection_tunnel_details.py index 18db513e5e..4f6ea93ccd 100644 --- a/src/oci/core/models/create_ip_sec_connection_tunnel_details.py +++ b/src/oci/core/models/create_ip_sec_connection_tunnel_details.py @@ -203,13 +203,6 @@ def shared_secret(self, shared_secret): def bgp_session_config(self): """ Gets the bgp_session_config of this CreateIPSecConnectionTunnelDetails. - Information for establishing a BGP session for the IPSec tunnel. Required if the tunnel uses - BGP dynamic routing. - - If the tunnel instead uses static routing, you may optionally provide - this object and set an IP address for one or both ends of the IPSec tunnel for the purposes - of troubleshooting or monitoring the tunnel. - :return: The bgp_session_config of this CreateIPSecConnectionTunnelDetails. :rtype: oci.core.models.CreateIPSecTunnelBgpSessionDetails @@ -220,13 +213,6 @@ def bgp_session_config(self): def bgp_session_config(self, bgp_session_config): """ Sets the bgp_session_config of this CreateIPSecConnectionTunnelDetails. - Information for establishing a BGP session for the IPSec tunnel. Required if the tunnel uses - BGP dynamic routing. - - If the tunnel instead uses static routing, you may optionally provide - this object and set an IP address for one or both ends of the IPSec tunnel for the purposes - of troubleshooting or monitoring the tunnel. - :param bgp_session_config: The bgp_session_config of this CreateIPSecConnectionTunnelDetails. :type: oci.core.models.CreateIPSecTunnelBgpSessionDetails diff --git a/src/oci/core/models/create_nat_gateway_details.py b/src/oci/core/models/create_nat_gateway_details.py index d1b490f210..dc4c458259 100644 --- a/src/oci/core/models/create_nat_gateway_details.py +++ b/src/oci/core/models/create_nat_gateway_details.py @@ -259,7 +259,7 @@ def vcn_id(self, vcn_id): def public_ip_id(self): """ Gets the public_ip_id of this CreateNatGatewayDetails. - The `OCID`__ of the Public IP associated with the NAT gateway. + The `OCID`__ of the public IP address associated with the NAT gateway. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm @@ -273,7 +273,7 @@ def public_ip_id(self): def public_ip_id(self, public_ip_id): """ Sets the public_ip_id of this CreateNatGatewayDetails. - The `OCID`__ of the Public IP associated with the NAT gateway. + The `OCID`__ of the public IP address associated with the NAT gateway. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm diff --git a/src/oci/core/models/create_public_ip_details.py b/src/oci/core/models/create_public_ip_details.py index 1849e4fda8..d3dd573908 100644 --- a/src/oci/core/models/create_public_ip_details.py +++ b/src/oci/core/models/create_public_ip_details.py @@ -286,7 +286,9 @@ def private_ip_id(self, private_ip_id): def public_ip_pool_id(self): """ Gets the public_ip_pool_id of this CreatePublicIpDetails. - OCID of the pool object created by the current tenancy + The `OCID`__ of the public IP pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The public_ip_pool_id of this CreatePublicIpDetails. @@ -298,7 +300,9 @@ def public_ip_pool_id(self): def public_ip_pool_id(self, public_ip_pool_id): """ Sets the public_ip_pool_id of this CreatePublicIpDetails. - OCID of the pool object created by the current tenancy + The `OCID`__ of the public IP pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param public_ip_pool_id: The public_ip_pool_id of this CreatePublicIpDetails. diff --git a/src/oci/core/models/create_public_ip_pool_details.py b/src/oci/core/models/create_public_ip_pool_details.py index daa8fae34c..dcee45b096 100644 --- a/src/oci/core/models/create_public_ip_pool_details.py +++ b/src/oci/core/models/create_public_ip_pool_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreatePublicIpPoolDetails(object): """ - The data to create a public ip pool + The information used to create a public IP pool. """ def __init__(self, **kwargs): @@ -58,7 +58,9 @@ def __init__(self, **kwargs): def compartment_id(self): """ **[Required]** Gets the compartment_id of this CreatePublicIpPoolDetails. - The OCID of the compartment to contain the Public Ip Pool + The `OCID`__ of the compartment containing the public IP pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this CreatePublicIpPoolDetails. @@ -70,7 +72,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this CreatePublicIpPoolDetails. - The OCID of the compartment to contain the Public Ip Pool + The `OCID`__ of the compartment containing the public IP pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this CreatePublicIpPoolDetails. diff --git a/src/oci/core/models/create_vcn_details.py b/src/oci/core/models/create_vcn_details.py index 4823bd6a46..9ba739a0cd 100644 --- a/src/oci/core/models/create_vcn_details.py +++ b/src/oci/core/models/create_vcn_details.py @@ -93,8 +93,7 @@ def __init__(self, **kwargs): def cidr_block(self): """ Gets the cidr_block of this CreateVcnDetails. - Deprecated. Instead use 'cidrBlocks'. It is an error to set both cidrBlock and - cidrBlocks. + **Deprecated.** Do *not* set this value. Use `cidrBlocks` instead. Example: `10.0.0.0/16` @@ -107,8 +106,7 @@ def cidr_block(self): def cidr_block(self, cidr_block): """ Sets the cidr_block of this CreateVcnDetails. - Deprecated. Instead use 'cidrBlocks'. It is an error to set both cidrBlock and - cidrBlocks. + **Deprecated.** Do *not* set this value. Use `cidrBlocks` instead. Example: `10.0.0.0/16` @@ -121,13 +119,12 @@ def cidr_block(self, cidr_block): def cidr_blocks(self): """ Gets the cidr_blocks of this CreateVcnDetails. - List of IPv4 CIDR blocks associated with the VCN. The CIDRs must maintain the following - rules - + The list of one or more IPv4 CIDR blocks for the VCN that meet the following criteria: + - The CIDR blocks must be valid. + - They must not overlap with each other or with the on-premises network CIDR block. + - The number of CIDR blocks must not exceed the limit of CIDR blocks allowed per VCN. - a. The list of CIDRs provided are valid - b. There is no overlap between different CIDRs - c. The number of CIDRs should not exceed the max limit of CIDRs per VCN - d. It is an error to set both cidrBlock and cidrBlocks. + **Important:** Do *not* specify a value for `cidrBlock`. Use this parameter instead. :return: The cidr_blocks of this CreateVcnDetails. @@ -139,13 +136,12 @@ def cidr_blocks(self): def cidr_blocks(self, cidr_blocks): """ Sets the cidr_blocks of this CreateVcnDetails. - List of IPv4 CIDR blocks associated with the VCN. The CIDRs must maintain the following - rules - + The list of one or more IPv4 CIDR blocks for the VCN that meet the following criteria: + - The CIDR blocks must be valid. + - They must not overlap with each other or with the on-premises network CIDR block. + - The number of CIDR blocks must not exceed the limit of CIDR blocks allowed per VCN. - a. The list of CIDRs provided are valid - b. There is no overlap between different CIDRs - c. The number of CIDRs should not exceed the max limit of CIDRs per VCN - d. It is an error to set both cidrBlock and cidrBlocks. + **Important:** Do *not* specify a value for `cidrBlock`. Use this parameter instead. :param cidr_blocks: The cidr_blocks of this CreateVcnDetails. diff --git a/src/oci/core/models/create_volume_details.py b/src/oci/core/models/create_volume_details.py index 04d22200b8..090c0feed7 100644 --- a/src/oci/core/models/create_volume_details.py +++ b/src/oci/core/models/create_volume_details.py @@ -417,10 +417,6 @@ 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. - 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. - :return: The source_details of this CreateVolumeDetails. :rtype: oci.core.models.VolumeSourceDetails @@ -431,10 +427,6 @@ 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. - 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. - :param source_details: The source_details of this CreateVolumeDetails. :type: oci.core.models.VolumeSourceDetails diff --git a/src/oci/core/models/create_volume_group_details.py b/src/oci/core/models/create_volume_group_details.py index a62c51cde2..0af338d578 100644 --- a/src/oci/core/models/create_volume_group_details.py +++ b/src/oci/core/models/create_volume_group_details.py @@ -22,6 +22,10 @@ def __init__(self, **kwargs): The value to assign to the availability_domain property of this CreateVolumeGroupDetails. :type availability_domain: str + :param backup_policy_id: + The value to assign to the backup_policy_id property of this CreateVolumeGroupDetails. + :type backup_policy_id: str + :param compartment_id: The value to assign to the compartment_id property of this CreateVolumeGroupDetails. :type compartment_id: str @@ -45,6 +49,7 @@ def __init__(self, **kwargs): """ self.swagger_types = { 'availability_domain': 'str', + 'backup_policy_id': 'str', 'compartment_id': 'str', 'defined_tags': 'dict(str, dict(str, object))', 'display_name': 'str', @@ -54,6 +59,7 @@ def __init__(self, **kwargs): self.attribute_map = { 'availability_domain': 'availabilityDomain', + 'backup_policy_id': 'backupPolicyId', 'compartment_id': 'compartmentId', 'defined_tags': 'definedTags', 'display_name': 'displayName', @@ -62,6 +68,7 @@ def __init__(self, **kwargs): } self._availability_domain = None + self._backup_policy_id = None self._compartment_id = None self._defined_tags = None self._display_name = None @@ -92,6 +99,32 @@ def availability_domain(self, availability_domain): """ self._availability_domain = availability_domain + @property + def backup_policy_id(self): + """ + Gets the backup_policy_id of this CreateVolumeGroupDetails. + If provided, specifies the ID of the volume backup policy to assign to the newly + created volume group. If omitted, no policy will be assigned. + + + :return: The backup_policy_id of this CreateVolumeGroupDetails. + :rtype: str + """ + return self._backup_policy_id + + @backup_policy_id.setter + def backup_policy_id(self, backup_policy_id): + """ + Sets the backup_policy_id of this CreateVolumeGroupDetails. + If provided, specifies the ID of the volume backup policy to assign to the newly + created volume group. If omitted, no policy will be assigned. + + + :param backup_policy_id: The backup_policy_id of this CreateVolumeGroupDetails. + :type: str + """ + self._backup_policy_id = backup_policy_id + @property def compartment_id(self): """ @@ -212,9 +245,6 @@ def freeform_tags(self, freeform_tags): 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. - :return: The source_details of this CreateVolumeGroupDetails. :rtype: oci.core.models.VolumeGroupSourceDetails @@ -225,9 +255,6 @@ def source_details(self): 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. - :param source_details: The source_details of this CreateVolumeGroupDetails. :type: oci.core.models.VolumeGroupSourceDetails diff --git a/src/oci/core/models/drg_attachment.py b/src/oci/core/models/drg_attachment.py index fbd38bf86d..905413e013 100644 --- a/src/oci/core/models/drg_attachment.py +++ b/src/oci/core/models/drg_attachment.py @@ -62,14 +62,14 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_state: str - :param route_table_id: - The value to assign to the route_table_id property of this DrgAttachment. - :type route_table_id: str - :param time_created: The value to assign to the time_created property of this DrgAttachment. :type time_created: datetime + :param route_table_id: + The value to assign to the route_table_id property of this DrgAttachment. + :type route_table_id: str + :param vcn_id: The value to assign to the vcn_id property of this DrgAttachment. :type vcn_id: str @@ -81,8 +81,8 @@ def __init__(self, **kwargs): 'drg_id': 'str', 'id': 'str', 'lifecycle_state': 'str', - 'route_table_id': 'str', 'time_created': 'datetime', + 'route_table_id': 'str', 'vcn_id': 'str' } @@ -92,8 +92,8 @@ def __init__(self, **kwargs): 'drg_id': 'drgId', 'id': 'id', 'lifecycle_state': 'lifecycleState', - 'route_table_id': 'routeTableId', 'time_created': 'timeCreated', + 'route_table_id': 'routeTableId', 'vcn_id': 'vcnId' } @@ -102,8 +102,8 @@ def __init__(self, **kwargs): self._drg_id = None self._id = None self._lifecycle_state = None - self._route_table_id = None self._time_created = None + self._route_table_id = None self._vcn_id = None @property @@ -234,6 +234,38 @@ def lifecycle_state(self, lifecycle_state): lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._lifecycle_state = lifecycle_state + @property + def time_created(self): + """ + Gets the time_created of this DrgAttachment. + The date and time the DRG attachment was created, in the format defined by `RFC3339`__. + + Example: `2016-08-25T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_created of this DrgAttachment. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this DrgAttachment. + The date and time the DRG attachment was created, in the format defined by `RFC3339`__. + + Example: `2016-08-25T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_created: The time_created of this DrgAttachment. + :type: datetime + """ + self._time_created = time_created + @property def route_table_id(self): """ @@ -274,38 +306,6 @@ def route_table_id(self, route_table_id): """ self._route_table_id = route_table_id - @property - def time_created(self): - """ - Gets the time_created of this DrgAttachment. - The date and time the DRG attachment was created, in the format defined by `RFC3339`__. - - Example: `2016-08-25T21:10:29.600Z` - - __ https://tools.ietf.org/html/rfc3339 - - - :return: The time_created of this DrgAttachment. - :rtype: datetime - """ - return self._time_created - - @time_created.setter - def time_created(self, time_created): - """ - Sets the time_created of this DrgAttachment. - The date and time the DRG attachment was created, in the format defined by `RFC3339`__. - - Example: `2016-08-25T21:10:29.600Z` - - __ https://tools.ietf.org/html/rfc3339 - - - :param time_created: The time_created of this DrgAttachment. - :type: datetime - """ - self._time_created = time_created - @property def vcn_id(self): """ diff --git a/src/oci/core/models/egress_security_rule.py b/src/oci/core/models/egress_security_rule.py index 0d43c1607a..6e1afd095b 100644 --- a/src/oci/core/models/egress_security_rule.py +++ b/src/oci/core/models/egress_security_rule.py @@ -192,21 +192,6 @@ def destination_type(self, destination_type): def icmp_options(self): """ Gets the icmp_options of this EgressSecurityRule. - Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code - as defined in: - - * `ICMP Parameters`__ - * `ICMPv6 Parameters`__ - - If you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and - codes are allowed. If you do provide this object, the type is required and the code is optional. - To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 (\"Destination - Unreachable\") code 4 (\"Fragmentation Needed and Don't Fragment was Set\"). If you need to specify - multiple codes for a single type, create a separate security list rule for each. - - __ http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml - __ https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml - :return: The icmp_options of this EgressSecurityRule. :rtype: oci.core.models.IcmpOptions @@ -217,21 +202,6 @@ def icmp_options(self): def icmp_options(self, icmp_options): """ Sets the icmp_options of this EgressSecurityRule. - Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code - as defined in: - - * `ICMP Parameters`__ - * `ICMPv6 Parameters`__ - - If you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and - codes are allowed. If you do provide this object, the type is required and the code is optional. - To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 (\"Destination - Unreachable\") code 4 (\"Fragmentation Needed and Don't Fragment was Set\"). If you need to specify - multiple codes for a single type, create a separate security list rule for each. - - __ http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml - __ https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml - :param icmp_options: The icmp_options of this EgressSecurityRule. :type: oci.core.models.IcmpOptions @@ -308,9 +278,6 @@ def protocol(self, protocol): def tcp_options(self): """ Gets the tcp_options of this EgressSecurityRule. - Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. - If you specify TCP as the protocol but omit this object, then all destination ports are allowed. - :return: The tcp_options of this EgressSecurityRule. :rtype: oci.core.models.TcpOptions @@ -321,9 +288,6 @@ def tcp_options(self): def tcp_options(self, tcp_options): """ Sets the tcp_options of this EgressSecurityRule. - Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. - If you specify TCP as the protocol but omit this object, then all destination ports are allowed. - :param tcp_options: The tcp_options of this EgressSecurityRule. :type: oci.core.models.TcpOptions @@ -334,9 +298,6 @@ def tcp_options(self, tcp_options): def udp_options(self): """ Gets the udp_options of this EgressSecurityRule. - Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. - If you specify UDP as the protocol but omit this object, then all destination ports are allowed. - :return: The udp_options of this EgressSecurityRule. :rtype: oci.core.models.UdpOptions @@ -347,9 +308,6 @@ def udp_options(self): def udp_options(self, udp_options): """ Sets the udp_options of this EgressSecurityRule. - Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. - If you specify UDP as the protocol but omit this object, then all destination ports are allowed. - :param udp_options: The udp_options of this EgressSecurityRule. :type: oci.core.models.UdpOptions diff --git a/src/oci/core/models/icmp_options.py b/src/oci/core/models/icmp_options.py index 2d6c3ae79f..06e9e12ac2 100644 --- a/src/oci/core/models/icmp_options.py +++ b/src/oci/core/models/icmp_options.py @@ -10,15 +10,19 @@ @init_model_state_from_kwargs class IcmpOptions(object): """ - Optional object to specify a particular ICMP type and code. If you specify ICMP as the protocol - but do not provide this object, then all ICMP types and codes are allowed. If you do provide - this object, the type is required and the code is optional. - See `ICMP Parameters`__ - for allowed values. To enable MTU negotiation for ingress internet traffic, make sure to allow - type 3 (\"Destination Unreachable\") code 4 (\"Fragmentation Needed and Don't Fragment was Set\"). - If you need to specify multiple codes for a single type, create a separate security list rule for each. + Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code + as defined in: + - `ICMP Parameters`__ + - `ICMPv6 Parameters`__ + + If you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and + codes are allowed. If you do provide this object, the type is required and the code is optional. + To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 (\"Destination + Unreachable\") code 4 (\"Fragmentation Needed and Don't Fragment was Set\"). If you need to specify + multiple codes for a single type, create a separate security list rule for each. __ http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml + __ https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml """ def __init__(self, **kwargs): diff --git a/src/oci/core/models/ingress_security_rule.py b/src/oci/core/models/ingress_security_rule.py index 6764f3cc1a..633b7953e7 100644 --- a/src/oci/core/models/ingress_security_rule.py +++ b/src/oci/core/models/ingress_security_rule.py @@ -96,21 +96,6 @@ def __init__(self, **kwargs): def icmp_options(self): """ Gets the icmp_options of this IngressSecurityRule. - Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code - as defined in: - - * `ICMP Parameters`__ - * `ICMPv6 Parameters`__ - - If you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and - codes are allowed. If you do provide this object, the type is required and the code is optional. - To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 (\"Destination - Unreachable\") code 4 (\"Fragmentation Needed and Don't Fragment was Set\"). If you need to specify - multiple codes for a single type, create a separate security list rule for each. - - __ http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml - __ https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml - :return: The icmp_options of this IngressSecurityRule. :rtype: oci.core.models.IcmpOptions @@ -121,21 +106,6 @@ def icmp_options(self): def icmp_options(self, icmp_options): """ Sets the icmp_options of this IngressSecurityRule. - Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code - as defined in: - - * `ICMP Parameters`__ - * `ICMPv6 Parameters`__ - - If you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and - codes are allowed. If you do provide this object, the type is required and the code is optional. - To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 (\"Destination - Unreachable\") code 4 (\"Fragmentation Needed and Don't Fragment was Set\"). If you need to specify - multiple codes for a single type, create a separate security list rule for each. - - __ http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml - __ https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml - :param icmp_options: The icmp_options of this IngressSecurityRule. :type: oci.core.models.IcmpOptions @@ -304,9 +274,6 @@ def source_type(self, source_type): def tcp_options(self): """ Gets the tcp_options of this IngressSecurityRule. - Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. - If you specify TCP as the protocol but omit this object, then all destination ports are allowed. - :return: The tcp_options of this IngressSecurityRule. :rtype: oci.core.models.TcpOptions @@ -317,9 +284,6 @@ def tcp_options(self): def tcp_options(self, tcp_options): """ Sets the tcp_options of this IngressSecurityRule. - Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. - If you specify TCP as the protocol but omit this object, then all destination ports are allowed. - :param tcp_options: The tcp_options of this IngressSecurityRule. :type: oci.core.models.TcpOptions @@ -330,9 +294,6 @@ def tcp_options(self, tcp_options): def udp_options(self): """ Gets the udp_options of this IngressSecurityRule. - Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. - If you specify UDP as the protocol but omit this object, then all destination ports are allowed. - :return: The udp_options of this IngressSecurityRule. :rtype: oci.core.models.UdpOptions @@ -343,9 +304,6 @@ def udp_options(self): def udp_options(self, udp_options): """ Sets the udp_options of this IngressSecurityRule. - Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. - If you specify UDP as the protocol but omit this object, then all destination ports are allowed. - :param udp_options: The udp_options of this IngressSecurityRule. :type: oci.core.models.UdpOptions diff --git a/src/oci/core/models/instance.py b/src/oci/core/models/instance.py index c14a479af4..2b4aab250a 100644 --- a/src/oci/core/models/instance.py +++ b/src/oci/core/models/instance.py @@ -680,8 +680,6 @@ def launch_mode(self, launch_mode): def launch_options(self): """ Gets the launch_options of this Instance. - Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values. - :return: The launch_options of this Instance. :rtype: oci.core.models.LaunchOptions @@ -692,8 +690,6 @@ def launch_options(self): def launch_options(self, launch_options): """ Sets the launch_options of this Instance. - Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values. - :param launch_options: The launch_options of this Instance. :type: oci.core.models.LaunchOptions @@ -724,8 +720,6 @@ def instance_options(self, instance_options): def availability_config(self): """ Gets the availability_config of this Instance. - Options for defining the availability of a VM instance after a maintenance event that impacts the underlying hardware. - :return: The availability_config of this Instance. :rtype: oci.core.models.InstanceAvailabilityConfig @@ -736,8 +730,6 @@ def availability_config(self): def availability_config(self, availability_config): """ Sets the availability_config of this Instance. - Options for defining the availability of a VM instance after a maintenance event that impacts the underlying hardware. - :param availability_config: The availability_config of this Instance. :type: oci.core.models.InstanceAvailabilityConfig @@ -884,8 +876,6 @@ def shape_config(self, shape_config): def source_details(self): """ Gets the source_details of this Instance. - Details for creating an instance - :return: The source_details of this Instance. :rtype: oci.core.models.InstanceSourceDetails @@ -896,8 +886,6 @@ def source_details(self): def source_details(self, source_details): """ Sets the source_details of this Instance. - Details for creating an instance - :param source_details: The source_details of this Instance. :type: oci.core.models.InstanceSourceDetails diff --git a/src/oci/core/models/instance_configuration_attach_vnic_details.py b/src/oci/core/models/instance_configuration_attach_vnic_details.py index 8886e33c10..f6d287d8dc 100644 --- a/src/oci/core/models/instance_configuration_attach_vnic_details.py +++ b/src/oci/core/models/instance_configuration_attach_vnic_details.py @@ -51,8 +51,6 @@ def __init__(self, **kwargs): def create_vnic_details(self): """ Gets the create_vnic_details of this InstanceConfigurationAttachVnicDetails. - Details for creating a new VNIC. - :return: The create_vnic_details of this InstanceConfigurationAttachVnicDetails. :rtype: oci.core.models.InstanceConfigurationCreateVnicDetails @@ -63,8 +61,6 @@ def create_vnic_details(self): def create_vnic_details(self, create_vnic_details): """ Sets the create_vnic_details of this InstanceConfigurationAttachVnicDetails. - Details for creating a new VNIC. - :param create_vnic_details: The create_vnic_details of this InstanceConfigurationAttachVnicDetails. :type: oci.core.models.InstanceConfigurationCreateVnicDetails diff --git a/src/oci/core/models/instance_configuration_create_volume_details.py b/src/oci/core/models/instance_configuration_create_volume_details.py index 90545eac95..71c4824d66 100644 --- a/src/oci/core/models/instance_configuration_create_volume_details.py +++ b/src/oci/core/models/instance_configuration_create_volume_details.py @@ -370,10 +370,6 @@ def size_in_gbs(self, size_in_gbs): def source_details(self): """ Gets the source_details of this InstanceConfigurationCreateVolumeDetails. - 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. - :return: The source_details of this InstanceConfigurationCreateVolumeDetails. :rtype: oci.core.models.InstanceConfigurationVolumeSourceDetails @@ -384,10 +380,6 @@ def source_details(self): def source_details(self, source_details): """ Sets the source_details of this InstanceConfigurationCreateVolumeDetails. - 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. - :param source_details: The source_details of this InstanceConfigurationCreateVolumeDetails. :type: oci.core.models.InstanceConfigurationVolumeSourceDetails diff --git a/src/oci/core/models/instance_configuration_launch_instance_details.py b/src/oci/core/models/instance_configuration_launch_instance_details.py index 2178fb3b7f..3a2fd99026 100644 --- a/src/oci/core/models/instance_configuration_launch_instance_details.py +++ b/src/oci/core/models/instance_configuration_launch_instance_details.py @@ -260,9 +260,6 @@ def compartment_id(self, compartment_id): def create_vnic_details(self): """ Gets the create_vnic_details of this InstanceConfigurationLaunchInstanceDetails. - Details for the primary VNIC, which is automatically created and attached when - the instance is launched. - :return: The create_vnic_details of this InstanceConfigurationLaunchInstanceDetails. :rtype: oci.core.models.InstanceConfigurationCreateVnicDetails @@ -273,9 +270,6 @@ def create_vnic_details(self): def create_vnic_details(self, create_vnic_details): """ Sets the create_vnic_details of this InstanceConfigurationLaunchInstanceDetails. - Details for the primary VNIC, which is automatically created and attached when - the instance is launched. - :param create_vnic_details: The create_vnic_details of this InstanceConfigurationLaunchInstanceDetails. :type: oci.core.models.InstanceConfigurationCreateVnicDetails @@ -670,9 +664,6 @@ def shape_config(self, shape_config): def source_details(self): """ Gets the source_details of this InstanceConfigurationLaunchInstanceDetails. - Details for creating an instance. - Use this parameter to specify whether a boot volume or an image should be used to launch a new instance. - :return: The source_details of this InstanceConfigurationLaunchInstanceDetails. :rtype: oci.core.models.InstanceConfigurationInstanceSourceDetails @@ -683,9 +674,6 @@ def source_details(self): def source_details(self, source_details): """ Sets the source_details of this InstanceConfigurationLaunchInstanceDetails. - Details for creating an instance. - Use this parameter to specify whether a boot volume or an image should be used to launch a new instance. - :param source_details: The source_details of this InstanceConfigurationLaunchInstanceDetails. :type: oci.core.models.InstanceConfigurationInstanceSourceDetails @@ -814,8 +802,6 @@ def launch_mode(self, launch_mode): def launch_options(self): """ Gets the launch_options of this InstanceConfigurationLaunchInstanceDetails. - Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values. - :return: The launch_options of this InstanceConfigurationLaunchInstanceDetails. :rtype: oci.core.models.InstanceConfigurationLaunchOptions @@ -826,8 +812,6 @@ def launch_options(self): def launch_options(self, launch_options): """ Sets the launch_options of this InstanceConfigurationLaunchInstanceDetails. - Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values. - :param launch_options: The launch_options of this InstanceConfigurationLaunchInstanceDetails. :type: oci.core.models.InstanceConfigurationLaunchOptions @@ -936,8 +920,6 @@ def instance_options(self, instance_options): def availability_config(self): """ Gets the availability_config of this InstanceConfigurationLaunchInstanceDetails. - Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware. - :return: The availability_config of this InstanceConfigurationLaunchInstanceDetails. :rtype: oci.core.models.InstanceConfigurationAvailabilityConfig @@ -948,8 +930,6 @@ def availability_config(self): def availability_config(self, availability_config): """ Sets the availability_config of this InstanceConfigurationLaunchInstanceDetails. - Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware. - :param availability_config: The availability_config of this InstanceConfigurationLaunchInstanceDetails. :type: oci.core.models.InstanceConfigurationAvailabilityConfig diff --git a/src/oci/core/models/ip_sec_connection_tunnel.py b/src/oci/core/models/ip_sec_connection_tunnel.py index 209421e65f..9e77f72fed 100644 --- a/src/oci/core/models/ip_sec_connection_tunnel.py +++ b/src/oci/core/models/ip_sec_connection_tunnel.py @@ -396,8 +396,6 @@ def display_name(self, display_name): def bgp_session_info(self): """ Gets the bgp_session_info of this IPSecConnectionTunnel. - Information for establishing the tunnel's BGP session. - :return: The bgp_session_info of this IPSecConnectionTunnel. :rtype: oci.core.models.BgpSessionInfo @@ -408,8 +406,6 @@ def bgp_session_info(self): def bgp_session_info(self, bgp_session_info): """ Sets the bgp_session_info of this IPSecConnectionTunnel. - Information for establishing the tunnel's BGP session. - :param bgp_session_info: The bgp_session_info of this IPSecConnectionTunnel. :type: oci.core.models.BgpSessionInfo diff --git a/src/oci/core/models/launch_instance_details.py b/src/oci/core/models/launch_instance_details.py index 1419546927..18e77f11ec 100644 --- a/src/oci/core/models/launch_instance_details.py +++ b/src/oci/core/models/launch_instance_details.py @@ -237,9 +237,6 @@ def compartment_id(self, compartment_id): def create_vnic_details(self): """ Gets the create_vnic_details of this LaunchInstanceDetails. - Details for the primary VNIC, which is automatically created and attached when - the instance is launched. - :return: The create_vnic_details of this LaunchInstanceDetails. :rtype: oci.core.models.CreateVnicDetails @@ -250,9 +247,6 @@ def create_vnic_details(self): def create_vnic_details(self, create_vnic_details): """ Sets the create_vnic_details of this LaunchInstanceDetails. - Details for the primary VNIC, which is automatically created and attached when - the instance is launched. - :param create_vnic_details: The create_vnic_details of this LaunchInstanceDetails. :type: oci.core.models.CreateVnicDetails @@ -601,9 +595,6 @@ def ipxe_script(self, ipxe_script): def launch_options(self): """ Gets the launch_options of this LaunchInstanceDetails. - Options for tuning the compatibility and performance of VM shapes. The values that you specify override any - default values. - :return: The launch_options of this LaunchInstanceDetails. :rtype: oci.core.models.LaunchOptions @@ -614,9 +605,6 @@ def launch_options(self): def launch_options(self, launch_options): """ Sets the launch_options of this LaunchInstanceDetails. - Options for tuning the compatibility and performance of VM shapes. The values that you specify override any - default values. - :param launch_options: The launch_options of this LaunchInstanceDetails. :type: oci.core.models.LaunchOptions @@ -647,8 +635,6 @@ def instance_options(self, instance_options): def availability_config(self): """ Gets the availability_config of this LaunchInstanceDetails. - Options for defining the availability of a VM instance after a maintenance event that impacts the underlying hardware. - :return: The availability_config of this LaunchInstanceDetails. :rtype: oci.core.models.LaunchInstanceAvailabilityConfigDetails @@ -659,8 +645,6 @@ def availability_config(self): def availability_config(self, availability_config): """ Sets the availability_config of this LaunchInstanceDetails. - Options for defining the availability of a VM instance after a maintenance event that impacts the underlying hardware. - :param availability_config: The availability_config of this LaunchInstanceDetails. :type: oci.core.models.LaunchInstanceAvailabilityConfigDetails @@ -865,9 +849,6 @@ def shape_config(self, shape_config): def source_details(self): """ Gets the source_details of this LaunchInstanceDetails. - Details for creating an instance. - Use this parameter to specify whether a boot volume or an image should be used to launch a new instance. - :return: The source_details of this LaunchInstanceDetails. :rtype: oci.core.models.InstanceSourceDetails @@ -878,9 +859,6 @@ def source_details(self): def source_details(self, source_details): """ Sets the source_details of this LaunchInstanceDetails. - Details for creating an instance. - Use this parameter to specify whether a boot volume or an image should be used to launch a new instance. - :param source_details: The source_details of this LaunchInstanceDetails. :type: oci.core.models.InstanceSourceDetails diff --git a/src/oci/core/models/modify_vcn_cidr_details.py b/src/oci/core/models/modify_vcn_cidr_details.py index 000e461ed9..48103c20e2 100644 --- a/src/oci/core/models/modify_vcn_cidr_details.py +++ b/src/oci/core/models/modify_vcn_cidr_details.py @@ -10,8 +10,7 @@ @init_model_state_from_kwargs class ModifyVcnCidrDetails(object): """ - Contains the original CIDR that needs to be updated and the - new CIDR which will replace the original CIDR. + Details for updating a CIDR block. """ def __init__(self, **kwargs): @@ -45,7 +44,7 @@ def __init__(self, **kwargs): def original_cidr_block(self): """ **[Required]** Gets the original_cidr_block of this ModifyVcnCidrDetails. - The CIDR IP address that needs to be updated. + The CIDR IP address to update. :return: The original_cidr_block of this ModifyVcnCidrDetails. @@ -57,7 +56,7 @@ def original_cidr_block(self): def original_cidr_block(self, original_cidr_block): """ Sets the original_cidr_block of this ModifyVcnCidrDetails. - The CIDR IP address that needs to be updated. + The CIDR IP address to update. :param original_cidr_block: The original_cidr_block of this ModifyVcnCidrDetails. @@ -69,7 +68,7 @@ def original_cidr_block(self, original_cidr_block): def new_cidr_block(self): """ **[Required]** Gets the new_cidr_block of this ModifyVcnCidrDetails. - The new CIDR IP address which will replace the orginal one. + The new CIDR IP address. :return: The new_cidr_block of this ModifyVcnCidrDetails. @@ -81,7 +80,7 @@ def new_cidr_block(self): def new_cidr_block(self, new_cidr_block): """ Sets the new_cidr_block of this ModifyVcnCidrDetails. - The new CIDR IP address which will replace the orginal one. + The new CIDR IP address. :param new_cidr_block: The new_cidr_block of this ModifyVcnCidrDetails. diff --git a/src/oci/core/models/nat_gateway.py b/src/oci/core/models/nat_gateway.py index 8896d9a0a7..50711829cd 100644 --- a/src/oci/core/models/nat_gateway.py +++ b/src/oci/core/models/nat_gateway.py @@ -436,7 +436,7 @@ def vcn_id(self, vcn_id): def public_ip_id(self): """ Gets the public_ip_id of this NatGateway. - The `OCID`__ of the Public IP associated with the NAT gateway. + The `OCID`__ of the public IP address associated with the NAT gateway. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm @@ -450,7 +450,7 @@ def public_ip_id(self): def public_ip_id(self, public_ip_id): """ Sets the public_ip_id of this NatGateway. - The `OCID`__ of the Public IP associated with the NAT gateway. + The `OCID`__ of the public IP address associated with the NAT gateway. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm diff --git a/src/oci/core/models/public_ip.py b/src/oci/core/models/public_ip.py index e1c9807054..5022c8b296 100644 --- a/src/oci/core/models/public_ip.py +++ b/src/oci/core/models/public_ip.py @@ -684,7 +684,9 @@ def time_created(self, time_created): def public_ip_pool_id(self): """ Gets the public_ip_pool_id of this PublicIp. - OCID of the pool object created by the current tenancy + The `OCID`__ of the pool object created in the current tenancy. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The public_ip_pool_id of this PublicIp. @@ -696,7 +698,9 @@ def public_ip_pool_id(self): def public_ip_pool_id(self, public_ip_pool_id): """ Sets the public_ip_pool_id of this PublicIp. - OCID of the pool object created by the current tenancy + The `OCID`__ of the pool object created in the current tenancy. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param public_ip_pool_id: The public_ip_pool_id of this PublicIp. diff --git a/src/oci/core/models/public_ip_pool.py b/src/oci/core/models/public_ip_pool.py index db8e9df9b4..8ecbb260ae 100644 --- a/src/oci/core/models/public_ip_pool.py +++ b/src/oci/core/models/public_ip_pool.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class PublicIpPool(object): """ - A Public IP pool, conceptually, is a set of public IP addresses (represented as one or more CIDRs) Users can be allocated addresses from this for internet access. + A public IP pool is a set of public IP addresses represented as one or more IPv4 CIDR blocks. Resources like load balancers and compute instances can be allocated public IP addresses from a public IP pool. """ #: A constant which can be used with the lifecycle_state property of a PublicIpPool. @@ -108,7 +108,7 @@ def __init__(self, **kwargs): def cidr_blocks(self): """ Gets the cidr_blocks of this PublicIpPool. - The CIDRs that make up this pool + The CIDR blocks added to this pool. This could be all or a portion of a BYOIP CIDR block. :return: The cidr_blocks of this PublicIpPool. @@ -120,7 +120,7 @@ def cidr_blocks(self): def cidr_blocks(self, cidr_blocks): """ Sets the cidr_blocks of this PublicIpPool. - The CIDRs that make up this pool + The CIDR blocks added to this pool. This could be all or a portion of a BYOIP CIDR block. :param cidr_blocks: The cidr_blocks of this PublicIpPool. @@ -132,7 +132,9 @@ def cidr_blocks(self, cidr_blocks): def compartment_id(self): """ **[Required]** Gets the compartment_id of this PublicIpPool. - The OCID of the compartment containing the Public IP Pool + The `OCID`__ of the compartment containing this pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this PublicIpPool. @@ -144,7 +146,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this PublicIpPool. - The OCID of the compartment containing the Public IP Pool + The `OCID`__ of the compartment containing this pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this PublicIpPool. @@ -250,7 +254,9 @@ def freeform_tags(self, freeform_tags): def id(self): """ **[Required]** Gets the id of this PublicIpPool. - The Oracle ID (OCID) of the Public Ip Pool. + The `OCID`__ of the public IP pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The id of this PublicIpPool. @@ -262,7 +268,9 @@ def id(self): def id(self, id): """ Sets the id of this PublicIpPool. - The Oracle ID (OCID) of the Public Ip Pool. + The `OCID`__ of the public IP pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param id: The id of this PublicIpPool. @@ -274,7 +282,7 @@ def id(self, id): def lifecycle_state(self): """ Gets the lifecycle_state of this PublicIpPool. - The Public IP Pool's current state. + The public IP pool's current state. Allowed values for this property are: "INACTIVE", "UPDATING", "ACTIVE", "DELETING", "DELETED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -289,7 +297,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this PublicIpPool. - The Public IP Pool's current state. + The public IP pool's current state. :param lifecycle_state: The lifecycle_state of this PublicIpPool. @@ -304,7 +312,7 @@ def lifecycle_state(self, lifecycle_state): def time_created(self): """ **[Required]** Gets the time_created of this PublicIpPool. - The date and time the public IP Pool was created, in the format defined by `RFC3339`__. + The date and time the public IP pool was created, in the format defined by `RFC3339`__. Example: `2016-08-25T21:10:29.600Z` @@ -320,7 +328,7 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this PublicIpPool. - The date and time the public IP Pool was created, in the format defined by `RFC3339`__. + The date and time the public IP pool was created, in the format defined by `RFC3339`__. Example: `2016-08-25T21:10:29.600Z` diff --git a/src/oci/core/models/public_ip_pool_collection.py b/src/oci/core/models/public_ip_pool_collection.py index 5500184461..1507205763 100644 --- a/src/oci/core/models/public_ip_pool_collection.py +++ b/src/oci/core/models/public_ip_pool_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class PublicIpPoolCollection(object): """ - Results of a ListPublicIpPool operation. + Results of a `ListPublicIpPool` operation. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this PublicIpPoolCollection. - list of Public Ip pool object summaries + A list of public IP pool summaries. :return: The items of this PublicIpPoolCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this PublicIpPoolCollection. - list of Public Ip pool object summaries + A list of public IP pool summaries. :param items: The items of this PublicIpPoolCollection. diff --git a/src/oci/core/models/public_ip_pool_summary.py b/src/oci/core/models/public_ip_pool_summary.py index cb1511c020..931eab7130 100644 --- a/src/oci/core/models/public_ip_pool_summary.py +++ b/src/oci/core/models/public_ip_pool_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class PublicIpPoolSummary(object): """ - Summary information about a Public IP pool + Summary information about a public IP pool. """ def __init__(self, **kwargs): @@ -79,7 +79,9 @@ def __init__(self, **kwargs): def compartment_id(self): """ Gets the compartment_id of this PublicIpPoolSummary. - The OCID of the compartment containing the Public IP Pool + The `OCID`__ of the compartment containing the public IP pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this PublicIpPoolSummary. @@ -91,7 +93,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this PublicIpPoolSummary. - The OCID of the compartment containing the Public IP Pool + The `OCID`__ of the compartment containing the public IP pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this PublicIpPoolSummary. @@ -197,7 +201,9 @@ def freeform_tags(self, freeform_tags): def id(self): """ Gets the id of this PublicIpPoolSummary. - The Oracle ID (OCID) of the Public Ip Pool. + The `OCID`__ of the public IP pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The id of this PublicIpPoolSummary. @@ -209,7 +215,9 @@ def id(self): def id(self, id): """ Sets the id of this PublicIpPoolSummary. - The Oracle ID (OCID) of the Public Ip Pool. + The `OCID`__ of the public IP pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param id: The id of this PublicIpPoolSummary. @@ -221,7 +229,7 @@ def id(self, id): def lifecycle_state(self): """ Gets the lifecycle_state of this PublicIpPoolSummary. - The Public IP Pool's current state. + The public IP pool's current state. :return: The lifecycle_state of this PublicIpPoolSummary. @@ -233,7 +241,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this PublicIpPoolSummary. - The Public IP Pool's current state. + The public IP pool's current state. :param lifecycle_state: The lifecycle_state of this PublicIpPoolSummary. @@ -245,7 +253,7 @@ def lifecycle_state(self, lifecycle_state): def time_created(self): """ Gets the time_created of this PublicIpPoolSummary. - The date and time the public IP Pool was created, in the format defined by `RFC3339`__. + The date and time the public IP pool was created, in the format defined by `RFC3339`__. Example: `2016-08-25T21:10:29.600Z` @@ -261,7 +269,7 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this PublicIpPoolSummary. - The date and time the public IP Pool was created, in the format defined by `RFC3339`__. + The date and time the public IP pool was created, in the format defined by `RFC3339`__. Example: `2016-08-25T21:10:29.600Z` diff --git a/src/oci/core/models/remove_public_ip_pool_capacity_details.py b/src/oci/core/models/remove_public_ip_pool_capacity_details.py index d9777d4140..c37d54f7bf 100644 --- a/src/oci/core/models/remove_public_ip_pool_capacity_details.py +++ b/src/oci/core/models/remove_public_ip_pool_capacity_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class RemovePublicIpPoolCapacityDetails(object): """ - The data to remove capacity from a public ip pool + The information needed to remove capacity from a public IP pool. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def cidr_block(self): """ **[Required]** Gets the cidr_block of this RemovePublicIpPoolCapacityDetails. - The CIDR IP address range to be removed from the Public Ip Pool + The CIDR block to remove from the public IP pool. Example: `10.0.1.0/24` @@ -50,7 +50,7 @@ def cidr_block(self): def cidr_block(self, cidr_block): """ Sets the cidr_block of this RemovePublicIpPoolCapacityDetails. - The CIDR IP address range to be removed from the Public Ip Pool + The CIDR block to remove from the public IP pool. Example: `10.0.1.0/24` diff --git a/src/oci/core/models/remove_vcn_cidr_details.py b/src/oci/core/models/remove_vcn_cidr_details.py index 9b03169a0d..3827e8fa78 100644 --- a/src/oci/core/models/remove_vcn_cidr_details.py +++ b/src/oci/core/models/remove_vcn_cidr_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class RemoveVcnCidrDetails(object): """ - Contains the CIDR which will be removed from the VCN. + Details for removing a CIDR block from a VCN. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def cidr_block(self): """ **[Required]** Gets the cidr_block of this RemoveVcnCidrDetails. - The CIDR IP address that needs to be removed. + The CIDR block to remove. :return: The cidr_block of this RemoveVcnCidrDetails. @@ -49,7 +49,7 @@ def cidr_block(self): def cidr_block(self, cidr_block): """ Sets the cidr_block of this RemoveVcnCidrDetails. - The CIDR IP address that needs to be removed. + The CIDR block to remove. :param cidr_block: The cidr_block of this RemoveVcnCidrDetails. diff --git a/src/oci/core/models/security_rule.py b/src/oci/core/models/security_rule.py index c7e79c228c..eb7de43c7e 100644 --- a/src/oci/core/models/security_rule.py +++ b/src/oci/core/models/security_rule.py @@ -332,20 +332,6 @@ def direction(self, direction): def icmp_options(self): """ Gets the icmp_options of this SecurityRule. - Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code - as defined in: - - `ICMP Parameters`__ - - `ICMPv6 Parameters`__ - - If you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and - codes are allowed. If you do provide this object, the type is required and the code is optional. - To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 (\"Destination - Unreachable\") code 4 (\"Fragmentation Needed and Don't Fragment was Set\"). If you need to specify - multiple codes for a single type, create a separate security rule for each. - - __ http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml - __ https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml - :return: The icmp_options of this SecurityRule. :rtype: oci.core.models.IcmpOptions @@ -356,20 +342,6 @@ def icmp_options(self): def icmp_options(self, icmp_options): """ Sets the icmp_options of this SecurityRule. - Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code - as defined in: - - `ICMP Parameters`__ - - `ICMPv6 Parameters`__ - - If you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and - codes are allowed. If you do provide this object, the type is required and the code is optional. - To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 (\"Destination - Unreachable\") code 4 (\"Fragmentation Needed and Don't Fragment was Set\"). If you need to specify - multiple codes for a single type, create a separate security rule for each. - - __ http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml - __ https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml - :param icmp_options: The icmp_options of this SecurityRule. :type: oci.core.models.IcmpOptions @@ -610,9 +582,6 @@ def source_type(self, source_type): def tcp_options(self): """ Gets the tcp_options of this SecurityRule. - Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. - If you specify TCP as the protocol but omit this object, then all destination ports are allowed. - :return: The tcp_options of this SecurityRule. :rtype: oci.core.models.TcpOptions @@ -623,9 +592,6 @@ def tcp_options(self): def tcp_options(self, tcp_options): """ Sets the tcp_options of this SecurityRule. - Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. - If you specify TCP as the protocol but omit this object, then all destination ports are allowed. - :param tcp_options: The tcp_options of this SecurityRule. :type: oci.core.models.TcpOptions @@ -664,9 +630,6 @@ def time_created(self, time_created): def udp_options(self): """ Gets the udp_options of this SecurityRule. - Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. - If you specify UDP as the protocol but omit this object, then all destination ports are allowed. - :return: The udp_options of this SecurityRule. :rtype: oci.core.models.UdpOptions @@ -677,9 +640,6 @@ def udp_options(self): def udp_options(self, udp_options): """ Sets the udp_options of this SecurityRule. - Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. - If you specify UDP as the protocol but omit this object, then all destination ports are allowed. - :param udp_options: The udp_options of this SecurityRule. :type: oci.core.models.UdpOptions diff --git a/src/oci/core/models/tcp_options.py b/src/oci/core/models/tcp_options.py index 4cf99dea2d..9e0ad71a2b 100644 --- a/src/oci/core/models/tcp_options.py +++ b/src/oci/core/models/tcp_options.py @@ -10,8 +10,8 @@ @init_model_state_from_kwargs class TcpOptions(object): """ - Optional object to specify ports for a TCP rule. If you specify TCP as the - protocol but omit this object, then all ports are allowed. + Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. + If you specify TCP as the protocol but omit this object, then all destination ports are allowed. """ def __init__(self, **kwargs): @@ -45,9 +45,6 @@ def __init__(self, **kwargs): def destination_port_range(self): """ Gets the destination_port_range of this TcpOptions. - An inclusive range of allowed destination ports. Use the same number for the min and max - to indicate a single port. Defaults to all ports if not specified. - :return: The destination_port_range of this TcpOptions. :rtype: oci.core.models.PortRange @@ -58,9 +55,6 @@ def destination_port_range(self): def destination_port_range(self, destination_port_range): """ Sets the destination_port_range of this TcpOptions. - An inclusive range of allowed destination ports. Use the same number for the min and max - to indicate a single port. Defaults to all ports if not specified. - :param destination_port_range: The destination_port_range of this TcpOptions. :type: oci.core.models.PortRange @@ -71,9 +65,6 @@ def destination_port_range(self, destination_port_range): def source_port_range(self): """ Gets the source_port_range of this TcpOptions. - An inclusive range of allowed source ports. Use the same number for the min and max to - indicate a single port. Defaults to all ports if not specified. - :return: The source_port_range of this TcpOptions. :rtype: oci.core.models.PortRange @@ -84,9 +75,6 @@ def source_port_range(self): def source_port_range(self, source_port_range): """ Sets the source_port_range of this TcpOptions. - An inclusive range of allowed source ports. Use the same number for the min and max to - indicate a single port. Defaults to all ports if not specified. - :param source_port_range: The source_port_range of this TcpOptions. :type: oci.core.models.PortRange diff --git a/src/oci/core/models/udp_options.py b/src/oci/core/models/udp_options.py index c576038ed4..a3c72c105b 100644 --- a/src/oci/core/models/udp_options.py +++ b/src/oci/core/models/udp_options.py @@ -10,8 +10,8 @@ @init_model_state_from_kwargs class UdpOptions(object): """ - Optional object to specify ports for a UDP rule. If you specify UDP as the - protocol but omit this object, then all ports are allowed. + Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. + If you specify UDP as the protocol but omit this object, then all destination ports are allowed. """ def __init__(self, **kwargs): @@ -45,9 +45,6 @@ def __init__(self, **kwargs): def destination_port_range(self): """ Gets the destination_port_range of this UdpOptions. - An inclusive range of allowed destination ports. Use the same number for the min and max - to indicate a single port. Defaults to all ports if not specified. - :return: The destination_port_range of this UdpOptions. :rtype: oci.core.models.PortRange @@ -58,9 +55,6 @@ def destination_port_range(self): def destination_port_range(self, destination_port_range): """ Sets the destination_port_range of this UdpOptions. - An inclusive range of allowed destination ports. Use the same number for the min and max - to indicate a single port. Defaults to all ports if not specified. - :param destination_port_range: The destination_port_range of this UdpOptions. :type: oci.core.models.PortRange @@ -71,9 +65,6 @@ def destination_port_range(self, destination_port_range): def source_port_range(self): """ Gets the source_port_range of this UdpOptions. - An inclusive range of allowed source ports. Use the same number for the min and max to - indicate a single port. Defaults to all ports if not specified. - :return: The source_port_range of this UdpOptions. :rtype: oci.core.models.PortRange @@ -84,9 +75,6 @@ def source_port_range(self): def source_port_range(self, source_port_range): """ Sets the source_port_range of this UdpOptions. - An inclusive range of allowed source ports. Use the same number for the min and max to - indicate a single port. Defaults to all ports if not specified. - :param source_port_range: The source_port_range of this UdpOptions. :type: oci.core.models.PortRange diff --git a/src/oci/core/models/update_byoip_range_details.py b/src/oci/core/models/update_byoip_range_details.py index a08dc802ae..55ea7ba324 100644 --- a/src/oci/core/models/update_byoip_range_details.py +++ b/src/oci/core/models/update_byoip_range_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class UpdateByoipRangeDetails(object): """ - The data to update a Byoip Range + The information used to update a `ByoipRange` resource. """ def __init__(self, **kwargs): diff --git a/src/oci/core/models/update_instance_details.py b/src/oci/core/models/update_instance_details.py index f0c13acc71..b4fe8283ba 100644 --- a/src/oci/core/models/update_instance_details.py +++ b/src/oci/core/models/update_instance_details.py @@ -212,8 +212,6 @@ def freeform_tags(self, freeform_tags): def agent_config(self): """ Gets the agent_config of this UpdateInstanceDetails. - Instance agent configuration options to choose for updating the instance - :return: The agent_config of this UpdateInstanceDetails. :rtype: oci.core.models.UpdateInstanceAgentConfigDetails @@ -224,8 +222,6 @@ def agent_config(self): def agent_config(self, agent_config): """ Sets the agent_config of this UpdateInstanceDetails. - Instance agent configuration options to choose for updating the instance - :param agent_config: The agent_config of this UpdateInstanceDetails. :type: oci.core.models.UpdateInstanceAgentConfigDetails @@ -470,8 +466,6 @@ def fault_domain(self, fault_domain): def launch_options(self): """ Gets the launch_options of this UpdateInstanceDetails. - Options for tuning the compatibility and performance of VM shapes. - :return: The launch_options of this UpdateInstanceDetails. :rtype: oci.core.models.UpdateLaunchOptions @@ -482,8 +476,6 @@ def launch_options(self): def launch_options(self, launch_options): """ Sets the launch_options of this UpdateInstanceDetails. - Options for tuning the compatibility and performance of VM shapes. - :param launch_options: The launch_options of this UpdateInstanceDetails. :type: oci.core.models.UpdateLaunchOptions @@ -494,8 +486,6 @@ def launch_options(self, launch_options): def availability_config(self): """ Gets the availability_config of this UpdateInstanceDetails. - Options for defining the availability of a VM instance after a maintenance event that impacts the underlying hardware. - :return: The availability_config of this UpdateInstanceDetails. :rtype: oci.core.models.UpdateInstanceAvailabilityConfigDetails @@ -506,8 +496,6 @@ def availability_config(self): def availability_config(self, availability_config): """ Sets the availability_config of this UpdateInstanceDetails. - Options for defining the availability of a VM instance after a maintenance event that impacts the underlying hardware. - :param availability_config: The availability_config of this UpdateInstanceDetails. :type: oci.core.models.UpdateInstanceAvailabilityConfigDetails diff --git a/src/oci/core/models/update_ip_sec_connection_tunnel_details.py b/src/oci/core/models/update_ip_sec_connection_tunnel_details.py index 4a692dd0f4..97c3cf674a 100644 --- a/src/oci/core/models/update_ip_sec_connection_tunnel_details.py +++ b/src/oci/core/models/update_ip_sec_connection_tunnel_details.py @@ -166,8 +166,6 @@ def ike_version(self, ike_version): def bgp_session_config(self): """ Gets the bgp_session_config of this UpdateIPSecConnectionTunnelDetails. - Information for establishing a BGP session for the IPSec tunnel. - :return: The bgp_session_config of this UpdateIPSecConnectionTunnelDetails. :rtype: oci.core.models.UpdateIPSecTunnelBgpSessionDetails @@ -178,8 +176,6 @@ def bgp_session_config(self): def bgp_session_config(self, bgp_session_config): """ Sets the bgp_session_config of this UpdateIPSecConnectionTunnelDetails. - Information for establishing a BGP session for the IPSec tunnel. - :param bgp_session_config: The bgp_session_config of this UpdateIPSecConnectionTunnelDetails. :type: oci.core.models.UpdateIPSecTunnelBgpSessionDetails diff --git a/src/oci/core/models/update_public_ip_pool_details.py b/src/oci/core/models/update_public_ip_pool_details.py index 465ef5127d..27f4ca49c8 100644 --- a/src/oci/core/models/update_public_ip_pool_details.py +++ b/src/oci/core/models/update_public_ip_pool_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class UpdatePublicIpPoolDetails(object): """ - The data to update a public ip pool + The data to update for a public IP pool. """ def __init__(self, **kwargs): diff --git a/src/oci/core/models/update_security_rule_details.py b/src/oci/core/models/update_security_rule_details.py index 57a9f45cee..b88719e84d 100644 --- a/src/oci/core/models/update_security_rule_details.py +++ b/src/oci/core/models/update_security_rule_details.py @@ -319,20 +319,6 @@ def direction(self, direction): def icmp_options(self): """ Gets the icmp_options of this UpdateSecurityRuleDetails. - Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code - as defined in: - - `ICMP Parameters`__ - - `ICMPv6 Parameters`__ - - If you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and - codes are allowed. If you do provide this object, the type is required and the code is optional. - To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 (\"Destination - Unreachable\") code 4 (\"Fragmentation Needed and Don't Fragment was Set\"). If you need to specify - multiple codes for a single type, create a separate security rule for each. - - __ http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml - __ https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml - :return: The icmp_options of this UpdateSecurityRuleDetails. :rtype: oci.core.models.IcmpOptions @@ -343,20 +329,6 @@ def icmp_options(self): def icmp_options(self, icmp_options): """ Sets the icmp_options of this UpdateSecurityRuleDetails. - Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code - as defined in: - - `ICMP Parameters`__ - - `ICMPv6 Parameters`__ - - If you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and - codes are allowed. If you do provide this object, the type is required and the code is optional. - To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 (\"Destination - Unreachable\") code 4 (\"Fragmentation Needed and Don't Fragment was Set\"). If you need to specify - multiple codes for a single type, create a separate security rule for each. - - __ http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml - __ https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml - :param icmp_options: The icmp_options of this UpdateSecurityRuleDetails. :type: oci.core.models.IcmpOptions @@ -569,9 +541,6 @@ def source_type(self, source_type): def tcp_options(self): """ Gets the tcp_options of this UpdateSecurityRuleDetails. - Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. - If you specify TCP as the protocol but omit this object, then all destination ports are allowed. - :return: The tcp_options of this UpdateSecurityRuleDetails. :rtype: oci.core.models.TcpOptions @@ -582,9 +551,6 @@ def tcp_options(self): def tcp_options(self, tcp_options): """ Sets the tcp_options of this UpdateSecurityRuleDetails. - Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. - If you specify TCP as the protocol but omit this object, then all destination ports are allowed. - :param tcp_options: The tcp_options of this UpdateSecurityRuleDetails. :type: oci.core.models.TcpOptions @@ -595,9 +561,6 @@ def tcp_options(self, tcp_options): def udp_options(self): """ Gets the udp_options of this UpdateSecurityRuleDetails. - Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. - If you specify UDP as the protocol but omit this object, then all destination ports are allowed. - :return: The udp_options of this UpdateSecurityRuleDetails. :rtype: oci.core.models.UdpOptions @@ -608,9 +571,6 @@ def udp_options(self): def udp_options(self, udp_options): """ Sets the udp_options of this UpdateSecurityRuleDetails. - Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. - If you specify UDP as the protocol but omit this object, then all destination ports are allowed. - :param udp_options: The udp_options of this UpdateSecurityRuleDetails. :type: oci.core.models.UdpOptions diff --git a/src/oci/core/models/update_subnet_details.py b/src/oci/core/models/update_subnet_details.py index 32a98425aa..9840cdcd34 100644 --- a/src/oci/core/models/update_subnet_details.py +++ b/src/oci/core/models/update_subnet_details.py @@ -251,13 +251,15 @@ def security_list_ids(self, security_list_ids): def cidr_block(self): """ Gets the cidr_block of this UpdateSubnetDetails. - The CIDR IP address block of the Subnet. The CIDR must maintain the following rules - + The CIDR block of the subnet. The new CIDR block must meet the following criteria: - a. The CIDR block is valid and correctly formatted. - b. The new range is within one of the parent VCN ranges. - c. The old and new CIDR ranges both use the same base address. Example: 10.0.0.0/25 and 10.0.0.0/24. - d. The new CIDR range contains all previously allocated private IP addresses in the old CIDR range. - e. No previously allocated IP address overlaps the broadcast address (the last IP of a subnet CIDR range) of the new CIDR range. + - Must be valid. + - The CIDR block's IP range must be completely within one of the VCN's CIDR block ranges. + - The old and new CIDR block ranges must use the same network address. Example: `10.0.0.0/25` and `10.0.0.0/24`. + - Must contain all IP addresses in use in the old CIDR range. + - The new CIDR range's broadcast address (last IP address of CIDR range) must not be an IP address in use in the old CIDR range. + + **Note:** If you are changing the CIDR block, you cannot create VNICs or private IPs for this resource while the update is in progress. Example: `172.16.0.0/16` @@ -271,13 +273,15 @@ def cidr_block(self): def cidr_block(self, cidr_block): """ Sets the cidr_block of this UpdateSubnetDetails. - The CIDR IP address block of the Subnet. The CIDR must maintain the following rules - + The CIDR block of the subnet. The new CIDR block must meet the following criteria: + + - Must be valid. + - The CIDR block's IP range must be completely within one of the VCN's CIDR block ranges. + - The old and new CIDR block ranges must use the same network address. Example: `10.0.0.0/25` and `10.0.0.0/24`. + - Must contain all IP addresses in use in the old CIDR range. + - The new CIDR range's broadcast address (last IP address of CIDR range) must not be an IP address in use in the old CIDR range. - a. The CIDR block is valid and correctly formatted. - b. The new range is within one of the parent VCN ranges. - c. The old and new CIDR ranges both use the same base address. Example: 10.0.0.0/25 and 10.0.0.0/24. - d. The new CIDR range contains all previously allocated private IP addresses in the old CIDR range. - e. No previously allocated IP address overlaps the broadcast address (the last IP of a subnet CIDR range) of the new CIDR range. + **Note:** If you are changing the CIDR block, you cannot create VNICs or private IPs for this resource while the update is in progress. Example: `172.16.0.0/16` diff --git a/src/oci/core/models/update_vlan_details.py b/src/oci/core/models/update_vlan_details.py index b1dd801370..a2b5e1818d 100644 --- a/src/oci/core/models/update_vlan_details.py +++ b/src/oci/core/models/update_vlan_details.py @@ -220,13 +220,15 @@ def route_table_id(self, route_table_id): def cidr_block(self): """ Gets the cidr_block of this UpdateVlanDetails. - The CIDR IP address block of the Vlan. The CIDR must maintain the following rules - + The CIDR block of the VLAN. The new CIDR block must meet the following criteria: - a. The CIDR block is valid and correctly formatted. - b. The new range is within one of the parent VCN ranges. - c. The old and new CIDR ranges both use the same base address. Example: 10.0.0.0/25 and 10.0.0.0/24. - d. The new CIDR range contains all previously allocated private IP addresses in the old CIDR range. - e. No previously allocated IP address overlaps the broadcast address (the last IP of a subnet CIDR range) of the new CIDR range. + - Must be valid. + - The CIDR block's IP range must be completely within one of the VCN's CIDR block ranges. + - The old and new CIDR block ranges must use the same network address. Example: `10.0.0.0/25` and `10.0.0.0/24`. + - Must contain all IP addresses in use in the old CIDR range. + - The new CIDR range's broadcast address (last IP address of CIDR range) must not be an IP address in use in the old CIDR range. + + **Note:** If you are changing the CIDR block, you cannot create VNICs or private IPs for this resource while the update is in progress. :return: The cidr_block of this UpdateVlanDetails. @@ -238,13 +240,15 @@ def cidr_block(self): def cidr_block(self, cidr_block): """ Sets the cidr_block of this UpdateVlanDetails. - The CIDR IP address block of the Vlan. The CIDR must maintain the following rules - + The CIDR block of the VLAN. The new CIDR block must meet the following criteria: + + - Must be valid. + - The CIDR block's IP range must be completely within one of the VCN's CIDR block ranges. + - The old and new CIDR block ranges must use the same network address. Example: `10.0.0.0/25` and `10.0.0.0/24`. + - Must contain all IP addresses in use in the old CIDR range. + - The new CIDR range's broadcast address (last IP address of CIDR range) must not be an IP address in use in the old CIDR range. - a. The CIDR block is valid and correctly formatted. - b. The new range is within one of the parent VCN ranges. - c. The old and new CIDR ranges both use the same base address. Example: 10.0.0.0/25 and 10.0.0.0/24. - d. The new CIDR range contains all previously allocated private IP addresses in the old CIDR range. - e. No previously allocated IP address overlaps the broadcast address (the last IP of a subnet CIDR range) of the new CIDR range. + **Note:** If you are changing the CIDR block, you cannot create VNICs or private IPs for this resource while the update is in progress. :param cidr_block: The cidr_block of this UpdateVlanDetails. diff --git a/src/oci/core/models/volume.py b/src/oci/core/models/volume.py index c4c304b273..8602bb5b09 100644 --- a/src/oci/core/models/volume.py +++ b/src/oci/core/models/volume.py @@ -564,9 +564,6 @@ 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. - If null, an empty volume is created. - :return: The source_details of this Volume. :rtype: oci.core.models.VolumeSourceDetails @@ -577,9 +574,6 @@ 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. - If null, an empty volume is created. - :param source_details: The source_details of this Volume. :type: oci.core.models.VolumeSourceDetails diff --git a/src/oci/core/models/volume_group.py b/src/oci/core/models/volume_group.py index b1f6d4654c..6e2e28e6c7 100644 --- a/src/oci/core/models/volume_group.py +++ b/src/oci/core/models/volume_group.py @@ -391,9 +391,6 @@ def size_in_gbs(self, size_in_gbs): def source_details(self): """ Gets the source_details of this VolumeGroup. - The volume group source. The source is either another a list of - volume IDs in the same availability domain, another volume group, or a volume group backup. - :return: The source_details of this VolumeGroup. :rtype: oci.core.models.VolumeGroupSourceDetails @@ -404,9 +401,6 @@ def source_details(self): def source_details(self, source_details): """ Sets the source_details of this VolumeGroup. - The volume group source. The source is either another a list of - volume IDs in the same availability domain, another volume group, or a volume group backup. - :param source_details: The source_details of this VolumeGroup. :type: oci.core.models.VolumeGroupSourceDetails diff --git a/src/oci/core/models/volume_group_backup.py b/src/oci/core/models/volume_group_backup.py index be462e77aa..cd82ab8340 100644 --- a/src/oci/core/models/volume_group_backup.py +++ b/src/oci/core/models/volume_group_backup.py @@ -52,6 +52,14 @@ class VolumeGroupBackup(object): #: This constant has a value of "REQUEST_RECEIVED" LIFECYCLE_STATE_REQUEST_RECEIVED = "REQUEST_RECEIVED" + #: A constant which can be used with the source_type property of a VolumeGroupBackup. + #: This constant has a value of "MANUAL" + SOURCE_TYPE_MANUAL = "MANUAL" + + #: A constant which can be used with the source_type property of a VolumeGroupBackup. + #: This constant has a value of "SCHEDULED" + SOURCE_TYPE_SCHEDULED = "SCHEDULED" + #: A constant which can be used with the type property of a VolumeGroupBackup. #: This constant has a value of "FULL" TYPE_FULL = "FULL" @@ -77,6 +85,10 @@ def __init__(self, **kwargs): The value to assign to the display_name property of this VolumeGroupBackup. :type display_name: str + :param expiration_time: + The value to assign to the expiration_time property of this VolumeGroupBackup. + :type expiration_time: datetime + :param freeform_tags: The value to assign to the freeform_tags property of this VolumeGroupBackup. :type freeform_tags: dict(str, str) @@ -99,6 +111,12 @@ def __init__(self, **kwargs): The value to assign to the size_in_gbs property of this VolumeGroupBackup. :type size_in_gbs: int + :param source_type: + The value to assign to the source_type property of this VolumeGroupBackup. + Allowed values for this property are: "MANUAL", "SCHEDULED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type source_type: str + :param time_created: The value to assign to the time_created property of this VolumeGroupBackup. :type time_created: datetime @@ -129,51 +147,63 @@ def __init__(self, **kwargs): The value to assign to the volume_group_id property of this VolumeGroupBackup. :type volume_group_id: str + :param source_volume_group_backup_id: + The value to assign to the source_volume_group_backup_id property of this VolumeGroupBackup. + :type source_volume_group_backup_id: str + """ self.swagger_types = { 'compartment_id': 'str', 'defined_tags': 'dict(str, dict(str, object))', 'display_name': 'str', + 'expiration_time': 'datetime', 'freeform_tags': 'dict(str, str)', 'id': 'str', 'lifecycle_state': 'str', 'size_in_mbs': 'int', 'size_in_gbs': 'int', + 'source_type': 'str', 'time_created': 'datetime', 'time_request_received': 'datetime', 'type': 'str', 'unique_size_in_mbs': 'int', 'unique_size_in_gbs': 'int', 'volume_backup_ids': 'list[str]', - 'volume_group_id': 'str' + 'volume_group_id': 'str', + 'source_volume_group_backup_id': 'str' } self.attribute_map = { 'compartment_id': 'compartmentId', 'defined_tags': 'definedTags', 'display_name': 'displayName', + 'expiration_time': 'expirationTime', 'freeform_tags': 'freeformTags', 'id': 'id', 'lifecycle_state': 'lifecycleState', 'size_in_mbs': 'sizeInMBs', 'size_in_gbs': 'sizeInGBs', + 'source_type': 'sourceType', 'time_created': 'timeCreated', 'time_request_received': 'timeRequestReceived', 'type': 'type', 'unique_size_in_mbs': 'uniqueSizeInMbs', 'unique_size_in_gbs': 'uniqueSizeInGbs', 'volume_backup_ids': 'volumeBackupIds', - 'volume_group_id': 'volumeGroupId' + 'volume_group_id': 'volumeGroupId', + 'source_volume_group_backup_id': 'sourceVolumeGroupBackupId' } self._compartment_id = None self._defined_tags = None self._display_name = None + self._expiration_time = None self._freeform_tags = None self._id = None self._lifecycle_state = None self._size_in_mbs = None self._size_in_gbs = None + self._source_type = None self._time_created = None self._time_request_received = None self._type = None @@ -181,6 +211,7 @@ def __init__(self, **kwargs): self._unique_size_in_gbs = None self._volume_backup_ids = None self._volume_group_id = None + self._source_volume_group_backup_id = None @property def compartment_id(self): @@ -264,6 +295,42 @@ def display_name(self, display_name): """ self._display_name = display_name + @property + def expiration_time(self): + """ + Gets the expiration_time of this VolumeGroupBackup. + The date and time the volume group backup will expire and be automatically deleted. + Format defined by `RFC3339`__. This parameter will always be present for volume group + backups that were created automatically by a scheduled-backup policy. For manually + created volume group backups, it will be absent, signifying that there is no expiration + time and the backup will last forever until manually deleted. + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The expiration_time of this VolumeGroupBackup. + :rtype: datetime + """ + return self._expiration_time + + @expiration_time.setter + def expiration_time(self, expiration_time): + """ + Sets the expiration_time of this VolumeGroupBackup. + The date and time the volume group backup will expire and be automatically deleted. + Format defined by `RFC3339`__. This parameter will always be present for volume group + backups that were created automatically by a scheduled-backup policy. For manually + created volume group backups, it will be absent, signifying that there is no expiration + time and the backup will last forever until manually deleted. + + __ https://tools.ietf.org/html/rfc3339 + + + :param expiration_time: The expiration_time of this VolumeGroupBackup. + :type: datetime + """ + self._expiration_time = expiration_time + @property def freeform_tags(self): """ @@ -400,6 +467,36 @@ def size_in_gbs(self, size_in_gbs): """ self._size_in_gbs = size_in_gbs + @property + def source_type(self): + """ + Gets the source_type of this VolumeGroupBackup. + Specifies whether the volume group backup was created manually, or via scheduled backup policy. + + Allowed values for this property are: "MANUAL", "SCHEDULED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The source_type of this VolumeGroupBackup. + :rtype: str + """ + return self._source_type + + @source_type.setter + def source_type(self, source_type): + """ + Sets the source_type of this VolumeGroupBackup. + Specifies whether the volume group backup was created manually, or via scheduled backup policy. + + + :param source_type: The source_type of this VolumeGroupBackup. + :type: str + """ + allowed_values = ["MANUAL", "SCHEDULED"] + if not value_allowed_none_or_none_sentinel(source_type, allowed_values): + source_type = 'UNKNOWN_ENUM_VALUE' + self._source_type = source_type + @property def time_created(self): """ @@ -592,6 +689,30 @@ def volume_group_id(self, volume_group_id): """ self._volume_group_id = volume_group_id + @property + def source_volume_group_backup_id(self): + """ + Gets the source_volume_group_backup_id of this VolumeGroupBackup. + The OCID of the source volume group backup. + + + :return: The source_volume_group_backup_id of this VolumeGroupBackup. + :rtype: str + """ + return self._source_volume_group_backup_id + + @source_volume_group_backup_id.setter + def source_volume_group_backup_id(self, source_volume_group_backup_id): + """ + Sets the source_volume_group_backup_id of this VolumeGroupBackup. + The OCID of the source volume group backup. + + + :param source_volume_group_backup_id: The source_volume_group_backup_id of this VolumeGroupBackup. + :type: str + """ + self._source_volume_group_backup_id = source_volume_group_backup_id + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/core/virtual_network_client.py b/src/oci/core/virtual_network_client.py index c1a4fa0ea0..ec77f7276f 100644 --- a/src/oci/core/virtual_network_client.py +++ b/src/oci/core/virtual_network_client.py @@ -166,14 +166,15 @@ def add_network_security_group_security_rules(self, network_security_group_id, a def add_public_ip_pool_capacity(self, public_ip_pool_id, add_public_ip_pool_capacity_details, **kwargs): """ - Adds a Cidr from the named Byoip Range prefix to the referenced Public IP Pool. - The cidr must be a subset of the Byoip Range in question. - The cidr must not overlap with any other cidr already added to this - or any other Public Ip Pool. + Adds some or all of a CIDR block to a public IP pool. + + The CIDR block (or subrange) must not overlap with any other CIDR block already added to this or any other public IP pool. :param str public_ip_pool_id: (required) - The OCID of the Public Ip Pool object. + The `OCID`__ of the public IP pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param oci.core.models.AddPublicIpPoolCapacityDetails add_public_ip_pool_capacity_details: (required) Byoip Range prefix and a cidr from it @@ -261,12 +262,13 @@ def add_public_ip_pool_capacity(self, public_ip_pool_id, add_public_ip_pool_capa def add_vcn_cidr(self, vcn_id, add_vcn_cidr_details, **kwargs): """ - Add a CIDR to a VCN. The new CIDR must maintain the following rules - + Adds a CIDR block to a VCN. The CIDR block you add: - a. The CIDR provided is valid - b. The new CIDR range should not overlap with any existing CIDRs - c. The new CIDR should not exceed the max limit of CIDRs per VCNs - d. The new CIDR range does not overlap with any peered VCNs + - Must be valid. + - Must not overlap with another CIDR block in the VCN, a CIDR block of a peered VCN, or the on-premises network CIDR block. + - Must not exceed the limit of CIDR blocks allowed per VCN. + + **Note:** Adding a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can take a few minutes. You can use the `GetWorkRequest` operation to check the status of the update. :param str vcn_id: (required) @@ -365,12 +367,14 @@ def add_vcn_cidr(self, vcn_id, add_vcn_cidr_details, **kwargs): def advertise_byoip_range(self, byoip_range_id, **kwargs): """ - initiate route advertisements for the Byoip Range prefix. - the prefix must be in PROVISIONED state + Begins BGP route advertisements for the BYOIP CIDR block you imported to the Oracle Cloud. + The `ByoipRange` resource must be in the PROVISIONED state before the BYOIP CIDR block routes can be advertised with BGP. :param str byoip_range_id: (required) - The OCID of the Byoip Range object. + The `OCID`__ of the `ByoipRange` resource containing the BYOIP CIDR block. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str opc_request_id: (optional) Unique identifier for the request. @@ -677,7 +681,7 @@ def bulk_delete_virtual_circuit_public_prefixes(self, virtual_circuit_id, bulk_d def change_byoip_range_compartment(self, byoip_range_id, change_byoip_range_compartment_details, **kwargs): """ - Moves a byoip range into a different compartment within the same tenancy. For information + Moves a BYOIP CIDR block to a different compartment. For information about moving resources between compartments, see `Moving Resources to a Different Compartment`__. @@ -685,10 +689,12 @@ def change_byoip_range_compartment(self, byoip_range_id, change_byoip_range_comp :param str byoip_range_id: (required) - The OCID of the Byoip Range object. + The `OCID`__ of the `ByoipRange` resource containing the BYOIP CIDR block. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param oci.core.models.ChangeByoipRangeCompartmentDetails change_byoip_range_compartment_details: (required) - Request to change the compartment of a Byoip Range. + Request to change the compartment of a BYOIP CIDR block. :param str opc_request_id: (optional) Unique identifier for the request. @@ -1811,7 +1817,7 @@ def change_public_ip_compartment(self, public_ip_id, change_public_ip_compartmen def change_public_ip_pool_compartment(self, public_ip_pool_id, change_public_ip_pool_compartment_details, **kwargs): """ - Moves a public IP pool into a different compartment within the same tenancy. For information + Moves a public IP pool to a different compartment. For information about moving resources between compartments, see `Moving Resources to a Different Compartment`__. @@ -1819,10 +1825,12 @@ def change_public_ip_pool_compartment(self, public_ip_pool_id, change_public_ip_ :param str public_ip_pool_id: (required) - The OCID of the Public Ip Pool object. + The `OCID`__ of the public IP pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param oci.core.models.ChangePublicIpPoolCompartmentDetails change_public_ip_pool_compartment_details: (required) - Request to change the compartment of a Public IP pool. + Request to change the compartment of a public IP pool. :param str opc_request_id: (optional) Unique identifier for the request. @@ -2826,11 +2834,11 @@ def connect_remote_peering_connections(self, remote_peering_connection_id, conne def create_byoip_range(self, create_byoip_range_details, **kwargs): """ - Creates a Byoip Range prefix. + Creates a subrange of the BYOIP CIDR block. :param oci.core.models.CreateByoipRangeDetails create_byoip_range_details: (required) - Create Byoip Range details. + Details needed to create a BYOIP CIDR block subrange. :param str opc_request_id: (optional) Unique identifier for the request. @@ -4088,7 +4096,7 @@ def create_public_ip(self, create_public_ip_details, **kwargs): def create_public_ip_pool(self, create_public_ip_pool_details, **kwargs): """ - Creates a Public Ip Pool + Creates a public IP pool. :param oci.core.models.CreatePublicIpPoolDetails create_public_ip_pool_details: (required) @@ -4610,23 +4618,20 @@ def create_vcn(self, create_vcn_details, **kwargs): Creates a new virtual cloud network (VCN). For more information, see `VCNs and Subnets`__. - To create the VCN, you may specify a list of IPv4 CIDR blocks. The CIDRs must maintain - the following rules - + For the VCN, you specify a list of one or more IPv4 CIDR blocks that meet the following criteria: - a. The list of CIDRs provided are valid - b. There is no overlap between different CIDRs - c. The list of CIDRs does not exceed the max limit of CIDRs per VCN + - The CIDR blocks must be valid. + - They must not overlap with each other or with the on-premises network CIDR block. + - The number of CIDR blocks does not exceed the limit of CIDR blocks allowed per VCN. - Oracle recommends using one of the private IP address ranges specified in `RFC 1918] - (https://tools.ietf.org/html/rfc1918) (10.0.0.0/8, 172.16/12, and 192.168/16). Example: - 172.16.0.0/16. The CIDR blocks can range from /16 to /30, and they must not overlap with - your on-premises network. + For a CIDR block, Oracle recommends that you use one of the private IP address ranges specified in `RFC 1918`__ (10.0.0.0/8, 172.16/12, and 192.168/16). Example: + 172.16.0.0/16. The CIDR blocks can range from /16 to /30. For the purposes of access control, you must provide the OCID of the compartment where you want the VCN to reside. Consult an Oracle Cloud Infrastructure administrator in your organization if you're not sure which compartment to use. Notice that the VCN doesn't have to be in the same compartment as the subnets or other Networking Service components. For more information about compartments and access control, see - [Overview of the IAM Service`__. For information about OCIDs, see + `Overview of the IAM Service`__. For information about OCIDs, see `Resource Identifiers`__. You may optionally specify a *display name* for the VCN, otherwise a default is provided. It does not have to @@ -4645,6 +4650,7 @@ def create_vcn(self, create_vcn_details, **kwargs): `Overview of the Networking Service`__. __ https://docs.cloud.oracle.com/Content/Network/Tasks/managingVCNs.htm + __ https://tools.ietf.org/html/rfc1918 __ https://docs.cloud.oracle.com/Content/Identity/Concepts/overview.htm __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm __ https://docs.cloud.oracle.com/Content/Network/Concepts/dns.htm @@ -4892,16 +4898,19 @@ def create_vlan(self, create_vlan_details, **kwargs): def delete_byoip_range(self, byoip_range_id, **kwargs): """ - Deletes the specified Byoip Range prefix. - The prefix must be in CREATING, PROVISIONED or FAILED state. - It must not have any subranges allocated to a Public Ip Pool object. - You must specify the object's OCID. + Deletes the specified `ByoipRange` resource. + The resource must be in one of the following states: CREATING, PROVISIONED, ACTIVE, or FAILED. + It must not have any subranges currently allocated to a PublicIpPool object or the deletion will fail. + You must specify the `OCID`__. + If the `ByoipRange` resource is currently in the PROVISIONED or ACTIVE state, it will be de-provisioned and then deleted. - In case the range is currently PROVISIONED, the operation will be asynchronous as it needs to be de-ptovisioned first. + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str byoip_range_id: (required) - The OCID of the Byoip Range object. + The `OCID`__ of the `ByoipRange` resource containing the BYOIP CIDR block. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str opc_request_id: (optional) Unique identifier for the request. @@ -6105,13 +6114,17 @@ def delete_public_ip(self, public_ip_id, **kwargs): def delete_public_ip_pool(self, public_ip_pool_id, **kwargs): """ - Deletes the specified Public Ip Pool - It must not have any active address allocations - You must specify the object's OCID. + Deletes the specified public IP pool. + To delete a public IP pool it must not have any active IP address allocations. + You must specify the object's `OCID`__ when deleting an IP pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str public_ip_pool_id: (required) - The OCID of the Public Ip Pool object. + The `OCID`__ of the public IP pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str opc_request_id: (optional) Unique identifier for the request. @@ -6915,11 +6928,15 @@ def detach_service_id(self, service_gateway_id, detach_service_details, **kwargs def get_byoip_range(self, byoip_range_id, **kwargs): """ - Gets the specified Byoip Range object. You must specify the object's OCID. + Gets the `ByoipRange` resource. You must specify the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str byoip_range_id: (required) - The OCID of the Byoip Range object. + The `OCID`__ of the `ByoipRange` resource containing the BYOIP CIDR block. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str opc_request_id: (optional) Unique identifier for the request. @@ -8991,11 +9008,15 @@ def get_public_ip_by_private_ip_id(self, get_public_ip_by_private_ip_id_details, def get_public_ip_pool(self, public_ip_pool_id, **kwargs): """ - Gets the specified Public Ip Pool object. You must specify the object's OCID. + Gets the specified `PublicIpPool` object. You must specify the object's `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str public_ip_pool_id: (required) - The OCID of the Public Ip Pool object. + The `OCID`__ of the public IP pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str opc_request_id: (optional) Unique identifier for the request. @@ -10065,12 +10086,14 @@ def list_allowed_peer_regions_for_remote_peering(self, **kwargs): def list_byoip_allocated_ranges(self, byoip_range_id, **kwargs): """ - Lists the ByoipAllocatedRange objects for the ByoipRange. - Each ByoipAllocatedRange object has a CIDR block part of the ByoipRange and the PublicIpPool it is assigned to. + Lists the subranges of a BYOIP CIDR block currently allocated to an IP pool. + Each `ByoipAllocatedRange` object also lists the IP pool where it is allocated. :param str byoip_range_id: (required) - The OCID of the Byoip Range object. + The `OCID`__ of the `ByoipRange` resource containing the BYOIP CIDR block. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str opc_request_id: (optional) Unique identifier for the request. @@ -10168,8 +10191,8 @@ def list_byoip_allocated_ranges(self, byoip_range_id, **kwargs): def list_byoip_ranges(self, compartment_id, **kwargs): """ - Lists the ByoipRange objects in the specified compartment. - You can filter the list by using query parameters. + Lists the `ByoipRange` resources in the specified compartment. + You can filter the list using query parameters. :param str compartment_id: (required) @@ -12713,8 +12736,8 @@ def list_private_ips(self, **kwargs): def list_public_ip_pools(self, compartment_id, **kwargs): """ - Lists the PublicIpPool objects in the specified compartment. - You can filter the list by using query parameters. + Lists the public IP pools in the specified compartment. + You can filter the list using query parameters. :param str compartment_id: (required) @@ -12746,7 +12769,7 @@ def list_public_ip_pools(self, compartment_id, **kwargs): A filter to return only resources that match the given display name exactly. :param str byoip_range_id: (optional) - A filter to return only resources that match the given Byoip Range + A filter to return only resources that match the given BYOIP CIDR block. :param str sort_by: (optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for @@ -14384,14 +14407,15 @@ def list_vlans(self, compartment_id, vcn_id, **kwargs): def modify_vcn_cidr(self, vcn_id, modify_vcn_cidr_details, **kwargs): """ - Update a CIDR from a VCN. The new CIDR must maintain the following rules - + Updates the specified CIDR block of a VCN. The new CIDR IP range must meet the following criteria: + + - Must be valid. + - Must not overlap with another CIDR block in the VCN, a CIDR block of a peered VCN, or the on-premises network CIDR block. + - Must not exceed the limit of CIDR blocks allowed per VCN. + - Must include IP addresses from the original CIDR block that are used in the VCN's existing route rules. + - No IP address in an existing subnet should be outside of the new CIDR block range. - a. The CIDR provided is valid - b. The new CIDR range should not overlap with any existing CIDRs - c. The new CIDR should not exceed the max limit of CIDRs per VCNs - d. The new CIDR range does not overlap with any peered VCNs - e. The new CIDR should overlap with any existing route rule within a VCN - f. All existing subnet CIDRs are subsets of the updated CIDR ranges + **Note:** Modifying a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can vary depending on the size of your network. Updating a small network could take about a minute, and updating a large network could take up to an hour. You can use the `GetWorkRequest` operation to check the status of the update. :param str vcn_id: (required) @@ -14562,14 +14586,16 @@ def remove_network_security_group_security_rules(self, network_security_group_id def remove_public_ip_pool_capacity(self, public_ip_pool_id, remove_public_ip_pool_capacity_details, **kwargs): """ - Removes a Cidr from the referenced Public IP Pool. + Removes a CIDR block from the referenced public IP pool. :param str public_ip_pool_id: (required) - The OCID of the Public Ip Pool object. + The `OCID`__ of the public IP pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param oci.core.models.RemovePublicIpPoolCapacityDetails remove_public_ip_pool_capacity_details: (required) - The Cidr to be removed from the Public Ip Pool + The CIDR block to remove from the IP pool. :param str opc_request_id: (optional) Unique identifier for the request. @@ -14654,8 +14680,11 @@ def remove_public_ip_pool_capacity(self, public_ip_pool_id, remove_public_ip_poo def remove_vcn_cidr(self, vcn_id, remove_vcn_cidr_details, **kwargs): """ - Remove a CIDR from a VCN. The CIDR being removed should not have - any resources allocated from it. + Removes a specified CIDR block from a VCN. + + **Notes:** + - You cannot remove a CIDR block if an IP address in its range is in use. + - Removing a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can take a few minutes. You can use the `GetWorkRequest` operation to check the status of the update. :param str vcn_id: (required) @@ -14754,11 +14783,13 @@ def remove_vcn_cidr(self, vcn_id, remove_vcn_cidr_details, **kwargs): def update_byoip_range(self, byoip_range_id, update_byoip_range_details, **kwargs): """ - Updates the specified Byoip Range. + Updates the tags or display name associated to the specified BYOIP CIDR block. :param str byoip_range_id: (required) - The OCID of the Byoip Range object. + The `OCID`__ of the `ByoipRange` resource containing the BYOIP CIDR block. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param oci.core.models.UpdateByoipRangeDetails update_byoip_range_details: (required) Byoip Range details. @@ -16353,14 +16384,16 @@ def update_public_ip(self, public_ip_id, update_public_ip_details, **kwargs): def update_public_ip_pool(self, public_ip_pool_id, update_public_ip_pool_details, **kwargs): """ - Updates the specified Public Ip Pool. + Updates the specified public IP pool. :param str public_ip_pool_id: (required) - The OCID of the Public Ip Pool object. + The `OCID`__ of the public IP pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param oci.core.models.UpdatePublicIpPoolDetails update_public_ip_pool_details: (required) - Public Ip Pool details. + Public IP pool details. :param str opc_request_id: (optional) Unique identifier for the request. @@ -17159,9 +17192,8 @@ def update_virtual_circuit(self, virtual_circuit_id, update_virtual_circuit_deta def update_vlan(self, vlan_id, update_vlan_details, **kwargs): """ - Updates the specified VLAN. This could result in changes to all - the VNICs in the VLAN, which can take time. During that transition - period, the VLAN will be in the UPDATING state. + Updates the specified VLAN. Note that this operation might require changes to all + the VNICs in the VLAN, which can take a while. The VLAN will be in the UPDATING state until the changes are complete. :param str vlan_id: (required) @@ -17333,12 +17365,16 @@ def update_vnic(self, vnic_id, update_vnic_details, **kwargs): def validate_byoip_range(self, byoip_range_id, **kwargs): """ - submit the Byoip Range for validation. This presumes the user has - updated their IP registry record in accordance to validation requirements + Submits the BYOIP CIDR block you are importing for validation. Do not submit to Oracle for validation if you have not already + modified the information for the BYOIP CIDR block with your Regional Internet Registry. See `To import a CIDR block`__ for details. + + __ https://docs.cloud.oracle.com/Content/Network/Concepts/BYOIP.htm#import_cidr :param str byoip_range_id: (required) - The OCID of the Byoip Range object. + The `OCID`__ of the `ByoipRange` resource containing the BYOIP CIDR block. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str opc_request_id: (optional) Unique identifier for the request. @@ -17408,11 +17444,13 @@ def validate_byoip_range(self, byoip_range_id, **kwargs): def withdraw_byoip_range(self, byoip_range_id, **kwargs): """ - stop route advertisements for the Byoip Range prefix. + Withdraws BGP route advertisement for the BYOIP CIDR block. :param str byoip_range_id: (required) - The OCID of the Byoip Range object. + The `OCID`__ of the `ByoipRange` resource containing the BYOIP CIDR block. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str opc_request_id: (optional) Unique identifier for the request. diff --git a/src/oci/core/virtual_network_client_composite_operations.py b/src/oci/core/virtual_network_client_composite_operations.py index 52e53418d9..3693e3dc8d 100644 --- a/src/oci/core/virtual_network_client_composite_operations.py +++ b/src/oci/core/virtual_network_client_composite_operations.py @@ -33,7 +33,9 @@ def add_public_ip_pool_capacity_and_wait_for_state(self, public_ip_pool_id, add_ to enter the given state(s). :param str public_ip_pool_id: (required) - The OCID of the Public Ip Pool object. + The `OCID`__ of the public IP pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param oci.core.models.AddPublicIpPoolCapacityDetails add_public_ip_pool_capacity_details: (required) Byoip Range prefix and a cidr from it @@ -313,7 +315,7 @@ def create_byoip_range_and_wait_for_state(self, create_byoip_range_details, wait to enter the given state(s). :param oci.core.models.CreateByoipRangeDetails create_byoip_range_details: (required) - Create Byoip Range details. + Details needed to create a BYOIP CIDR block subrange. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.core.models.ByoipRange.lifecycle_state` @@ -1149,7 +1151,9 @@ def delete_byoip_range_and_wait_for_work_request(self, byoip_range_id, work_requ to enter the given state(s). :param str byoip_range_id: (required) - The OCID of the Byoip Range object. + The `OCID`__ of the `ByoipRange` resource containing the BYOIP CIDR block. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param list[str] work_request_states: (optional) An array of work requests states to wait on. These should be valid values for :py:attr:`~oci.work_requests.models.WorkRequest.status` @@ -1754,7 +1758,9 @@ def delete_public_ip_pool_and_wait_for_state(self, public_ip_pool_id, wait_for_s to enter the given state(s). :param str public_ip_pool_id: (required) - The OCID of the Public Ip Pool object. + The `OCID`__ of the public IP pool. + + __ https://docs.cloud.oracle.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.core.models.PublicIpPool.lifecycle_state` @@ -2266,10 +2272,12 @@ def remove_public_ip_pool_capacity_and_wait_for_state(self, public_ip_pool_id, r to enter the given state(s). :param str public_ip_pool_id: (required) - The OCID of the Public Ip Pool object. + The `OCID`__ of the public IP pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param oci.core.models.RemovePublicIpPoolCapacityDetails remove_public_ip_pool_capacity_details: (required) - The Cidr to be removed from the Public Ip Pool + The CIDR block to remove from the IP pool. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.core.models.PublicIpPool.lifecycle_state` @@ -2347,7 +2355,9 @@ def update_byoip_range_and_wait_for_state(self, byoip_range_id, update_byoip_ran to enter the given state(s). :param str byoip_range_id: (required) - The OCID of the Byoip Range object. + The `OCID`__ of the `ByoipRange` resource containing the BYOIP CIDR block. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param oci.core.models.UpdateByoipRangeDetails update_byoip_range_details: (required) Byoip Range details. @@ -2932,10 +2942,12 @@ def update_public_ip_pool_and_wait_for_state(self, public_ip_pool_id, update_pub to enter the given state(s). :param str public_ip_pool_id: (required) - The OCID of the Public Ip Pool object. + The `OCID`__ of the public IP pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param oci.core.models.UpdatePublicIpPoolDetails update_public_ip_pool_details: (required) - Public Ip Pool details. + Public IP pool details. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.core.models.PublicIpPool.lifecycle_state` @@ -3348,7 +3360,9 @@ def validate_byoip_range_and_wait_for_work_request(self, byoip_range_id, work_re to enter the given state(s). :param str byoip_range_id: (required) - The OCID of the Byoip Range object. + The `OCID`__ of the `ByoipRange` resource containing the BYOIP CIDR block. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param list[str] work_request_states: (optional) An array of work requests states to wait on. These should be valid values for :py:attr:`~oci.work_requests.models.WorkRequest.status` diff --git a/src/oci/database/database_client.py b/src/oci/database/database_client.py index 7fbdba73c8..2cf6a14fa4 100644 --- a/src/oci/database/database_client.py +++ b/src/oci/database/database_client.py @@ -1099,6 +1099,13 @@ def change_db_system_compartment(self, change_compartment_details, db_system_id, :param oci.database.models.ChangeCompartmentDetails change_compartment_details: (required) Request to move the DB system to a different compartment. + **Note:** Deprecated for Exadata Cloud Service systems. Use the `new resource model APIs`__ instead. + + For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See `Switching an Exadata DB System to the New Resource Model and APIs`__ for details on converting existing Exadata DB systems to the new resource model. + + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem_topic-resource_model_conversion.htm + :param str db_system_id: (required) The DB system `OCID`__. @@ -7095,6 +7102,13 @@ def get_db_system(self, db_system_id, **kwargs): """ Gets information about the specified DB system. + **Note:** Deprecated for Exadata Cloud Service systems. Use the `new resource model APIs`__ instead. + + For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See `Switching an Exadata DB System to the New Resource Model and APIs`__ for details on converting existing Exadata DB systems to the new resource model. + + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem_topic-resource_model_conversion.htm + :param str db_system_id: (required) The DB system `OCID`__. @@ -7464,9 +7478,19 @@ def get_exadata_infrastructure_ocpus(self, autonomous_exadata_infrastructure_id, def get_exadata_iorm_config(self, db_system_id, **kwargs): """ - Gets the IORM configuration settings for the specified cloud Exadata system. + Gets the IORM configuration settings for the specified cloud Exadata DB system. All Exadata service instances have default IORM settings. + **Note:** Deprecated for Exadata Cloud Service systems. Use the `new resource model APIs`__ instead. + + For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See `Switching an Exadata DB System to the New Resource Model and APIs`__ for details on converting existing Exadata DB systems to the new resource model. + + The :func:`get_cloud_vm_cluster_iorm_config` API is used for this operation with Exadata systems using the + new resource model. + + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem_topic-resource_model_conversion.htm + :param str db_system_id: (required) The DB system `OCID`__. @@ -8141,18 +8165,29 @@ def launch_db_system(self, launch_db_system_details, **kwargs): 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 - options. For detailed information about default options, see the following: + options. For detailed information about default options, see `Bare metal and virtual machine DB system default options.`__ + + **Note:** Deprecated for Exadata Cloud Service systems. Use the `new resource model APIs`__ instead. + + For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See `Switching an Exadata DB System to the New Resource Model and APIs`__ for details on converting existing Exadata DB systems to the new resource model. - - `Bare metal and virtual machine DB system default options`__ - - `Exadata DB system default options`__ + Use the :func:`create_cloud_exadata_infrastructure` and :func:`create_cloud_vm_cluster` APIs to provision a new Exadata Cloud Service instance. - __ https://docs.cloud.oracle.com/Content/Database/Tasks/creatingDBsystem.htm#DefaultOptionsfortheInitialDatabase - __ https://docs.cloud.oracle.com/Content/Database/Tasks/exacreatingDBsystem.htm#DefaultOptionsfortheInitialDatabase + __ https://docs.cloud.oracle.com/Content/Database/Tasks/creatingDBsystem.htm#Default + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem_topic-resource_model_conversion.htm :param oci.database.models.LaunchDbSystemBase launch_db_system_details: (required) Request to launch a DB system. + **Note:** Deprecated for Exadata Cloud Service systems. Use the `new resource model APIs`__ instead. + + For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See `Switching an Exadata DB System to the New Resource Model and APIs`__ for details on converting existing Exadata DB systems to the new resource model. + + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem_topic-resource_model_conversion.htm + :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 @@ -8349,7 +8384,7 @@ def list_autonomous_container_databases(self, compartment_id, **kwargs): :param str lifecycle_state: (optional) A filter to return only resources that match the given lifecycle state exactly. - Allowed values are: "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", "BACKUP_IN_PROGRESS", "RESTORING", "RESTORE_FAILED", "RESTARTING", "MAINTENANCE_IN_PROGRESS", "ROLE_CHANGE_IN_PROGRESS" + Allowed values are: "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", "BACKUP_IN_PROGRESS", "RESTORING", "RESTORE_FAILED", "RESTARTING", "MAINTENANCE_IN_PROGRESS", "ROLE_CHANGE_IN_PROGRESS", "UNAVAILABLE" :param str availability_domain: (optional) A filter to return only resources that match the given availability domain exactly. @@ -8419,7 +8454,7 @@ def list_autonomous_container_databases(self, compartment_id, **kwargs): ) if 'lifecycle_state' in kwargs: - lifecycle_state_allowed_values = ["PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", "BACKUP_IN_PROGRESS", "RESTORING", "RESTORE_FAILED", "RESTARTING", "MAINTENANCE_IN_PROGRESS", "ROLE_CHANGE_IN_PROGRESS"] + lifecycle_state_allowed_values = ["PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", "BACKUP_IN_PROGRESS", "RESTORING", "RESTORE_FAILED", "RESTARTING", "MAINTENANCE_IN_PROGRESS", "ROLE_CHANGE_IN_PROGRESS", "UNAVAILABLE"] if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: raise ValueError( "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) @@ -10671,7 +10706,7 @@ def list_database_software_images(self, compartment_id, **kwargs): def list_database_upgrade_history_entries(self, database_id, **kwargs): """ - gets the upgrade history for a specified database. + Gets the upgrade history for a specified database in a bare metal or virtual machine DB system. :param str database_id: (required) @@ -11669,6 +11704,13 @@ def list_db_systems(self, compartment_id, **kwargs): """ Lists 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. + **Note:** Deprecated for Exadata Cloud Service systems. Use the `new resource model APIs`__ instead. + + For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See `Switching an Exadata DB System to the New Resource Model and APIs`__ for details on converting existing Exadata DB systems to the new resource model. + + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem_topic-resource_model_conversion.htm + :param str compartment_id: (required) The compartment `OCID`__. @@ -12942,7 +12984,10 @@ def list_vm_clusters(self, compartment_id, **kwargs): def migrate_exadata_db_system_resource_model(self, db_system_id, **kwargs): """ - Migrates the Exadata DB system to the cloud Exadata infrastructure model. All related resources will be migrated. + Migrates the Exadata DB system to the new `Exadata resource model`__. + All related resources will be migrated. + + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model :param str db_system_id: (required) @@ -14797,6 +14842,13 @@ def terminate_db_system(self, db_system_id, **kwargs): """ 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. + **Note:** Deprecated for Exadata Cloud Service systems. Use the `new resource model APIs`__ instead. + + For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See `Switching an Exadata DB System to the New Resource Model and APIs`__ for details on converting existing Exadata DB systems to the new resource model. + + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem_topic-resource_model_conversion.htm + :param str db_system_id: (required) The DB system `OCID`__. @@ -15974,6 +16026,13 @@ def update_db_system(self, db_system_id, update_db_system_details, **kwargs): """ Updates the properties of the specified DB system. + **Note:** Deprecated for Exadata Cloud Service systems. Use the `new resource model APIs`__ instead. + + For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See `Switching an Exadata DB System to the New Resource Model and APIs`__ for details on converting existing Exadata DB systems to the new resource model. + + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem_topic-resource_model_conversion.htm + :param str db_system_id: (required) The DB system `OCID`__. @@ -16146,7 +16205,17 @@ def update_exadata_infrastructure(self, exadata_infrastructure_id, update_exadat def update_exadata_iorm_config(self, db_system_id, exadata_iorm_config_update_details, **kwargs): """ - Updates IORM settings for the specified Exadata system. + Updates IORM settings for the specified Exadata DB system. + + **Note:** Deprecated for Exadata Cloud Service systems. Use the `new resource model APIs`__ instead. + + For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See `Switching an Exadata DB System to the New Resource Model and APIs`__ for details on converting existing Exadata DB systems to the new resource model. + + The :func:`update_cloud_vm_cluster_iorm_config` API is used for Exadata systems using the + new resource model. + + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem_topic-resource_model_conversion.htm :param str db_system_id: (required) @@ -16591,7 +16660,7 @@ def update_vm_cluster_network(self, exadata_infrastructure_id, vm_cluster_networ def upgrade_database(self, database_id, upgrade_database_details, **kwargs): """ - Upgrade the specified database. + Upgrades the specified Oracle Database instance. :param str database_id: (required) @@ -16600,7 +16669,7 @@ def upgrade_database(self, database_id, upgrade_database_details, **kwargs): __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param oci.database.models.UpgradeDatabaseDetails upgrade_database_details: (required) - Request to perform database upgrade. + Request to perform a database upgrade. :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 9dace171ae..7d026d2d03 100644 --- a/src/oci/database/database_client_composite_operations.py +++ b/src/oci/database/database_client_composite_operations.py @@ -521,6 +521,13 @@ def change_db_system_compartment_and_wait_for_work_request(self, change_compartm :param oci.database.models.ChangeCompartmentDetails change_compartment_details: (required) Request to move the DB system to a different compartment. + **Note:** Deprecated for Exadata Cloud Service systems. Use the `new resource model APIs`__ instead. + + For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See `Switching an Exadata DB System to the New Resource Model and APIs`__ for details on converting existing Exadata DB systems to the new resource model. + + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem_topic-resource_model_conversion.htm + :param str db_system_id: (required) The DB system `OCID`__. @@ -2965,6 +2972,13 @@ def launch_db_system_and_wait_for_work_request(self, launch_db_system_details, w :param oci.database.models.LaunchDbSystemBase launch_db_system_details: (required) Request to launch a DB system. + **Note:** Deprecated for Exadata Cloud Service systems. Use the `new resource model APIs`__ instead. + + For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See `Switching an Exadata DB System to the New Resource Model and APIs`__ for details on converting existing Exadata DB systems to the new resource model. + + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem_topic-resource_model_conversion.htm + :param list[str] work_request_states: (optional) An array of work requests states to wait on. These should be valid values for :py:attr:`~oci.work_requests.models.WorkRequest.status` Default values are termination states: [STATUS_SUCCEEDED, STATUS_FAILED, STATUS_CANCELED] @@ -3000,6 +3014,13 @@ def launch_db_system_and_wait_for_state(self, launch_db_system_details, wait_for :param oci.database.models.LaunchDbSystemBase launch_db_system_details: (required) Request to launch a DB system. + **Note:** Deprecated for Exadata Cloud Service systems. Use the `new resource model APIs`__ instead. + + For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See `Switching an Exadata DB System to the New Resource Model and APIs`__ for details on converting existing Exadata DB systems to the new resource model. + + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem_topic-resource_model_conversion.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.DbSystem.lifecycle_state` @@ -5900,7 +5921,7 @@ def upgrade_database_and_wait_for_work_request(self, database_id, upgrade_databa __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param oci.database.models.UpgradeDatabaseDetails upgrade_database_details: (required) - Request to perform database upgrade. + Request to perform a database upgrade. :param list[str] work_request_states: (optional) An array of work requests states to wait on. These should be valid values for :py:attr:`~oci.work_requests.models.WorkRequest.status` @@ -5940,7 +5961,7 @@ def upgrade_database_and_wait_for_state(self, database_id, upgrade_database_deta __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param oci.database.models.UpgradeDatabaseDetails upgrade_database_details: (required) - Request to perform database upgrade. + Request to perform a database upgrade. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.database.models.Database.lifecycle_state` diff --git a/src/oci/database/models/autonomous_container_database.py b/src/oci/database/models/autonomous_container_database.py index b03f872e1f..d515d35e58 100644 --- a/src/oci/database/models/autonomous_container_database.py +++ b/src/oci/database/models/autonomous_container_database.py @@ -81,6 +81,10 @@ class AutonomousContainerDatabase(object): #: This constant has a value of "ROLE_CHANGE_IN_PROGRESS" LIFECYCLE_STATE_ROLE_CHANGE_IN_PROGRESS = "ROLE_CHANGE_IN_PROGRESS" + #: A constant which can be used with the lifecycle_state property of a AutonomousContainerDatabase. + #: This constant has a value of "UNAVAILABLE" + LIFECYCLE_STATE_UNAVAILABLE = "UNAVAILABLE" + #: A constant which can be used with the patch_model property of a AutonomousContainerDatabase. #: This constant has a value of "RELEASE_UPDATES" PATCH_MODEL_RELEASE_UPDATES = "RELEASE_UPDATES" @@ -152,7 +156,7 @@ def __init__(self, **kwargs): :param lifecycle_state: The value to assign to the lifecycle_state property of this AutonomousContainerDatabase. - Allowed values for this property are: "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", "BACKUP_IN_PROGRESS", "RESTORING", "RESTORE_FAILED", "RESTARTING", "MAINTENANCE_IN_PROGRESS", "ROLE_CHANGE_IN_PROGRESS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", "BACKUP_IN_PROGRESS", "RESTORING", "RESTORE_FAILED", "RESTARTING", "MAINTENANCE_IN_PROGRESS", "ROLE_CHANGE_IN_PROGRESS", "UNAVAILABLE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_state: str @@ -577,7 +581,7 @@ def lifecycle_state(self): **[Required]** Gets the lifecycle_state of this AutonomousContainerDatabase. The current state of the Autonomous Container Database. - Allowed values for this property are: "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", "BACKUP_IN_PROGRESS", "RESTORING", "RESTORE_FAILED", "RESTARTING", "MAINTENANCE_IN_PROGRESS", "ROLE_CHANGE_IN_PROGRESS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", "BACKUP_IN_PROGRESS", "RESTORING", "RESTORE_FAILED", "RESTARTING", "MAINTENANCE_IN_PROGRESS", "ROLE_CHANGE_IN_PROGRESS", "UNAVAILABLE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -596,7 +600,7 @@ def lifecycle_state(self, lifecycle_state): :param lifecycle_state: The lifecycle_state of this AutonomousContainerDatabase. :type: str """ - allowed_values = ["PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", "BACKUP_IN_PROGRESS", "RESTORING", "RESTORE_FAILED", "RESTARTING", "MAINTENANCE_IN_PROGRESS", "ROLE_CHANGE_IN_PROGRESS"] + allowed_values = ["PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", "BACKUP_IN_PROGRESS", "RESTORING", "RESTORE_FAILED", "RESTARTING", "MAINTENANCE_IN_PROGRESS", "ROLE_CHANGE_IN_PROGRESS", "UNAVAILABLE"] if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._lifecycle_state = lifecycle_state diff --git a/src/oci/database/models/autonomous_container_database_dataguard_association.py b/src/oci/database/models/autonomous_container_database_dataguard_association.py index f13bebaf8c..98ba3f436d 100644 --- a/src/oci/database/models/autonomous_container_database_dataguard_association.py +++ b/src/oci/database/models/autonomous_container_database_dataguard_association.py @@ -49,6 +49,10 @@ class AutonomousContainerDatabaseDataguardAssociation(object): #: This constant has a value of "FAILED" LIFECYCLE_STATE_FAILED = "FAILED" + #: A constant which can be used with the lifecycle_state property of a AutonomousContainerDatabaseDataguardAssociation. + #: This constant has a value of "UNAVAILABLE" + LIFECYCLE_STATE_UNAVAILABLE = "UNAVAILABLE" + #: A constant which can be used with the peer_role property of a AutonomousContainerDatabaseDataguardAssociation. #: This constant has a value of "PRIMARY" PEER_ROLE_PRIMARY = "PRIMARY" @@ -85,6 +89,10 @@ class AutonomousContainerDatabaseDataguardAssociation(object): #: This constant has a value of "FAILED" PEER_LIFECYCLE_STATE_FAILED = "FAILED" + #: A constant which can be used with the peer_lifecycle_state property of a AutonomousContainerDatabaseDataguardAssociation. + #: This constant has a value of "UNAVAILABLE" + PEER_LIFECYCLE_STATE_UNAVAILABLE = "UNAVAILABLE" + #: A constant which can be used with the protection_mode property of a AutonomousContainerDatabaseDataguardAssociation. #: This constant has a value of "MAXIMUM_AVAILABILITY" PROTECTION_MODE_MAXIMUM_AVAILABILITY = "MAXIMUM_AVAILABILITY" @@ -114,7 +122,7 @@ def __init__(self, **kwargs): :param lifecycle_state: The value to assign to the lifecycle_state property of this AutonomousContainerDatabaseDataguardAssociation. - Allowed values for this property are: "PROVISIONING", "AVAILABLE", "ROLE_CHANGE_IN_PROGRESS", "TERMINATING", "TERMINATED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "PROVISIONING", "AVAILABLE", "ROLE_CHANGE_IN_PROGRESS", "TERMINATING", "TERMINATED", "FAILED", "UNAVAILABLE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_state: str @@ -138,7 +146,7 @@ def __init__(self, **kwargs): :param peer_lifecycle_state: The value to assign to the peer_lifecycle_state property of this AutonomousContainerDatabaseDataguardAssociation. - Allowed values for this property are: "PROVISIONING", "AVAILABLE", "ROLE_CHANGE_IN_PROGRESS", "TERMINATING", "TERMINATED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "PROVISIONING", "AVAILABLE", "ROLE_CHANGE_IN_PROGRESS", "TERMINATING", "TERMINATED", "FAILED", "UNAVAILABLE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type peer_lifecycle_state: str @@ -316,7 +324,7 @@ def lifecycle_state(self): **[Required]** Gets the lifecycle_state of this AutonomousContainerDatabaseDataguardAssociation. The current state of Autonomous Data Guard. - Allowed values for this property are: "PROVISIONING", "AVAILABLE", "ROLE_CHANGE_IN_PROGRESS", "TERMINATING", "TERMINATED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "PROVISIONING", "AVAILABLE", "ROLE_CHANGE_IN_PROGRESS", "TERMINATING", "TERMINATED", "FAILED", "UNAVAILABLE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -335,7 +343,7 @@ def lifecycle_state(self, lifecycle_state): :param lifecycle_state: The lifecycle_state of this AutonomousContainerDatabaseDataguardAssociation. :type: str """ - allowed_values = ["PROVISIONING", "AVAILABLE", "ROLE_CHANGE_IN_PROGRESS", "TERMINATING", "TERMINATED", "FAILED"] + allowed_values = ["PROVISIONING", "AVAILABLE", "ROLE_CHANGE_IN_PROGRESS", "TERMINATING", "TERMINATED", "FAILED", "UNAVAILABLE"] if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._lifecycle_state = lifecycle_state @@ -452,7 +460,7 @@ def peer_lifecycle_state(self): Gets the peer_lifecycle_state of this AutonomousContainerDatabaseDataguardAssociation. The current state of Autonomous Data Guard. - Allowed values for this property are: "PROVISIONING", "AVAILABLE", "ROLE_CHANGE_IN_PROGRESS", "TERMINATING", "TERMINATED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "PROVISIONING", "AVAILABLE", "ROLE_CHANGE_IN_PROGRESS", "TERMINATING", "TERMINATED", "FAILED", "UNAVAILABLE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -471,7 +479,7 @@ def peer_lifecycle_state(self, peer_lifecycle_state): :param peer_lifecycle_state: The peer_lifecycle_state of this AutonomousContainerDatabaseDataguardAssociation. :type: str """ - allowed_values = ["PROVISIONING", "AVAILABLE", "ROLE_CHANGE_IN_PROGRESS", "TERMINATING", "TERMINATED", "FAILED"] + allowed_values = ["PROVISIONING", "AVAILABLE", "ROLE_CHANGE_IN_PROGRESS", "TERMINATING", "TERMINATED", "FAILED", "UNAVAILABLE"] if not value_allowed_none_or_none_sentinel(peer_lifecycle_state, allowed_values): peer_lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._peer_lifecycle_state = peer_lifecycle_state diff --git a/src/oci/database/models/autonomous_container_database_summary.py b/src/oci/database/models/autonomous_container_database_summary.py index 71b0f71d81..94cc12caa4 100644 --- a/src/oci/database/models/autonomous_container_database_summary.py +++ b/src/oci/database/models/autonomous_container_database_summary.py @@ -81,6 +81,10 @@ class AutonomousContainerDatabaseSummary(object): #: This constant has a value of "ROLE_CHANGE_IN_PROGRESS" LIFECYCLE_STATE_ROLE_CHANGE_IN_PROGRESS = "ROLE_CHANGE_IN_PROGRESS" + #: A constant which can be used with the lifecycle_state property of a AutonomousContainerDatabaseSummary. + #: This constant has a value of "UNAVAILABLE" + LIFECYCLE_STATE_UNAVAILABLE = "UNAVAILABLE" + #: A constant which can be used with the patch_model property of a AutonomousContainerDatabaseSummary. #: This constant has a value of "RELEASE_UPDATES" PATCH_MODEL_RELEASE_UPDATES = "RELEASE_UPDATES" @@ -152,7 +156,7 @@ def __init__(self, **kwargs): :param lifecycle_state: The value to assign to the lifecycle_state property of this AutonomousContainerDatabaseSummary. - Allowed values for this property are: "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", "BACKUP_IN_PROGRESS", "RESTORING", "RESTORE_FAILED", "RESTARTING", "MAINTENANCE_IN_PROGRESS", "ROLE_CHANGE_IN_PROGRESS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", "BACKUP_IN_PROGRESS", "RESTORING", "RESTORE_FAILED", "RESTARTING", "MAINTENANCE_IN_PROGRESS", "ROLE_CHANGE_IN_PROGRESS", "UNAVAILABLE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_state: str @@ -577,7 +581,7 @@ def lifecycle_state(self): **[Required]** Gets the lifecycle_state of this AutonomousContainerDatabaseSummary. The current state of the Autonomous Container Database. - Allowed values for this property are: "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", "BACKUP_IN_PROGRESS", "RESTORING", "RESTORE_FAILED", "RESTARTING", "MAINTENANCE_IN_PROGRESS", "ROLE_CHANGE_IN_PROGRESS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", "BACKUP_IN_PROGRESS", "RESTORING", "RESTORE_FAILED", "RESTARTING", "MAINTENANCE_IN_PROGRESS", "ROLE_CHANGE_IN_PROGRESS", "UNAVAILABLE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -596,7 +600,7 @@ def lifecycle_state(self, lifecycle_state): :param lifecycle_state: The lifecycle_state of this AutonomousContainerDatabaseSummary. :type: str """ - allowed_values = ["PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", "BACKUP_IN_PROGRESS", "RESTORING", "RESTORE_FAILED", "RESTARTING", "MAINTENANCE_IN_PROGRESS", "ROLE_CHANGE_IN_PROGRESS"] + allowed_values = ["PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", "BACKUP_IN_PROGRESS", "RESTORING", "RESTORE_FAILED", "RESTARTING", "MAINTENANCE_IN_PROGRESS", "ROLE_CHANGE_IN_PROGRESS", "UNAVAILABLE"] if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._lifecycle_state = lifecycle_state diff --git a/src/oci/database/models/autonomous_database.py b/src/oci/database/models/autonomous_database.py index d8ba88859f..f3421afe1e 100644 --- a/src/oci/database/models/autonomous_database.py +++ b/src/oci/database/models/autonomous_database.py @@ -362,6 +362,14 @@ def __init__(self, **kwargs): The value to assign to the whitelisted_ips property of this AutonomousDatabase. :type whitelisted_ips: list[str] + :param are_primary_whitelisted_ips_used: + The value to assign to the are_primary_whitelisted_ips_used property of this AutonomousDatabase. + :type are_primary_whitelisted_ips_used: bool + + :param standby_whitelisted_ips: + The value to assign to the standby_whitelisted_ips property of this AutonomousDatabase. + :type standby_whitelisted_ips: list[str] + :param apex_details: The value to assign to the apex_details property of this AutonomousDatabase. :type apex_details: oci.database.models.AutonomousDatabaseApex @@ -509,6 +517,8 @@ def __init__(self, **kwargs): 'db_workload': 'str', 'is_access_control_enabled': 'bool', 'whitelisted_ips': 'list[str]', + 'are_primary_whitelisted_ips_used': 'bool', + 'standby_whitelisted_ips': 'list[str]', 'apex_details': 'AutonomousDatabaseApex', 'is_auto_scaling_enabled': 'bool', 'data_safe_status': 'str', @@ -571,6 +581,8 @@ def __init__(self, **kwargs): 'db_workload': 'dbWorkload', 'is_access_control_enabled': 'isAccessControlEnabled', 'whitelisted_ips': 'whitelistedIps', + 'are_primary_whitelisted_ips_used': 'arePrimaryWhitelistedIpsUsed', + 'standby_whitelisted_ips': 'standbyWhitelistedIps', 'apex_details': 'apexDetails', 'is_auto_scaling_enabled': 'isAutoScalingEnabled', 'data_safe_status': 'dataSafeStatus', @@ -632,6 +644,8 @@ def __init__(self, **kwargs): self._db_workload = None self._is_access_control_enabled = None self._whitelisted_ips = None + self._are_primary_whitelisted_ips_used = None + self._standby_whitelisted_ips = None self._apex_details = None self._is_auto_scaling_enabled = None self._data_safe_status = None @@ -1526,7 +1540,7 @@ def db_workload(self): - OLTP - indicates an Autonomous Transaction Processing database - DW - indicates an Autonomous Data Warehouse database - AJD - indicates an Autonomous JSON Database - - APEX - indicates an Autonomous Database with the Oracle Application Express (APEX) workload type. + - APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. Allowed values for this property are: "OLTP", "DW", "AJD", "APEX", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -1546,7 +1560,7 @@ def db_workload(self, db_workload): - OLTP - indicates an Autonomous Transaction Processing database - DW - indicates an Autonomous Data Warehouse database - AJD - indicates an Autonomous JSON Database - - APEX - indicates an Autonomous Database with the Oracle Application Express (APEX) workload type. + - APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. :param db_workload: The db_workload of this AutonomousDatabase. @@ -1639,11 +1653,85 @@ def whitelisted_ips(self, whitelisted_ips): """ self._whitelisted_ips = whitelisted_ips + @property + def are_primary_whitelisted_ips_used(self): + """ + Gets the are_primary_whitelisted_ips_used of this AutonomousDatabase. + This field will be null if the Autonomous Database is not Data Guard enabled or Access Control is disabled. + It's value would be `TRUE` if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses primary IP access control list (ACL) for standby. + It's value would be `FALSE` if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses different IP access control list (ACL) for standby compared to primary. + + + :return: The are_primary_whitelisted_ips_used of this AutonomousDatabase. + :rtype: bool + """ + return self._are_primary_whitelisted_ips_used + + @are_primary_whitelisted_ips_used.setter + def are_primary_whitelisted_ips_used(self, are_primary_whitelisted_ips_used): + """ + Sets the are_primary_whitelisted_ips_used of this AutonomousDatabase. + This field will be null if the Autonomous Database is not Data Guard enabled or Access Control is disabled. + It's value would be `TRUE` if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses primary IP access control list (ACL) for standby. + It's value would be `FALSE` if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses different IP access control list (ACL) for standby compared to primary. + + + :param are_primary_whitelisted_ips_used: The are_primary_whitelisted_ips_used of this AutonomousDatabase. + :type: bool + """ + self._are_primary_whitelisted_ips_used = are_primary_whitelisted_ips_used + + @property + def standby_whitelisted_ips(self): + """ + Gets the standby_whitelisted_ips of this AutonomousDatabase. + The client IP access control list (ACL). This feature is available for autonomous databases on `shared Exadata infrastructure`__ and on Exadata Cloud@Customer. + Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. + + For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. + Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. + Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]` + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. + Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]` + + For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. + + __ https://docs.cloud.oracle.com/Content/Database/Concepts/adboverview.htm#AEI + + + :return: The standby_whitelisted_ips of this AutonomousDatabase. + :rtype: list[str] + """ + return self._standby_whitelisted_ips + + @standby_whitelisted_ips.setter + def standby_whitelisted_ips(self, standby_whitelisted_ips): + """ + Sets the standby_whitelisted_ips of this AutonomousDatabase. + The client IP access control list (ACL). This feature is available for autonomous databases on `shared Exadata infrastructure`__ and on Exadata Cloud@Customer. + Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. + + For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. + Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. + Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]` + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. + Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]` + + For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. + + __ https://docs.cloud.oracle.com/Content/Database/Concepts/adboverview.htm#AEI + + + :param standby_whitelisted_ips: The standby_whitelisted_ips of this AutonomousDatabase. + :type: list[str] + """ + self._standby_whitelisted_ips = standby_whitelisted_ips + @property def apex_details(self): """ Gets the apex_details of this AutonomousDatabase. - Information about Autonomous Application Express. + Information about Oracle APEX Application Development. :return: The apex_details of this AutonomousDatabase. @@ -1655,7 +1743,7 @@ def apex_details(self): def apex_details(self, apex_details): """ Sets the apex_details of this AutonomousDatabase. - Information about Autonomous Application Express. + Information about Oracle APEX Application Development. :param apex_details: The apex_details of this AutonomousDatabase. diff --git a/src/oci/database/models/autonomous_database_apex.py b/src/oci/database/models/autonomous_database_apex.py index f1d79f5a55..5a10cf6a6a 100644 --- a/src/oci/database/models/autonomous_database_apex.py +++ b/src/oci/database/models/autonomous_database_apex.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class AutonomousDatabaseApex(object): """ - Oracle Application Express (APEX) is a low-code development platform that enables you to build scalable, secure enterprise apps, with world-class features. Autonomous Database with the APEX workload type is optimized to support APEX development. + Oracle APEX Application Development is a low-code development platform that enables you to build scalable, secure enterprise apps, with world-class features. Autonomous Database with the APEX workload type is optimized to support APEX development. """ def __init__(self, **kwargs): @@ -44,7 +44,7 @@ def __init__(self, **kwargs): def apex_version(self): """ Gets the apex_version of this AutonomousDatabaseApex. - The Oracle Application Express service version. + The Oracle APEX Application Development version. :return: The apex_version of this AutonomousDatabaseApex. @@ -56,7 +56,7 @@ def apex_version(self): def apex_version(self, apex_version): """ Sets the apex_version of this AutonomousDatabaseApex. - The Oracle Application Express service version. + The Oracle APEX Application Development version. :param apex_version: The apex_version of this AutonomousDatabaseApex. diff --git a/src/oci/database/models/autonomous_database_dataguard_association.py b/src/oci/database/models/autonomous_database_dataguard_association.py index 5b60a6dadf..f2cf4446fb 100644 --- a/src/oci/database/models/autonomous_database_dataguard_association.py +++ b/src/oci/database/models/autonomous_database_dataguard_association.py @@ -51,6 +51,10 @@ class AutonomousDatabaseDataguardAssociation(object): #: This constant has a value of "FAILED" LIFECYCLE_STATE_FAILED = "FAILED" + #: A constant which can be used with the lifecycle_state property of a AutonomousDatabaseDataguardAssociation. + #: This constant has a value of "UNAVAILABLE" + LIFECYCLE_STATE_UNAVAILABLE = "UNAVAILABLE" + #: A constant which can be used with the peer_role property of a AutonomousDatabaseDataguardAssociation. #: This constant has a value of "PRIMARY" PEER_ROLE_PRIMARY = "PRIMARY" @@ -87,6 +91,10 @@ class AutonomousDatabaseDataguardAssociation(object): #: This constant has a value of "FAILED" PEER_AUTONOMOUS_DATABASE_LIFE_CYCLE_STATE_FAILED = "FAILED" + #: A constant which can be used with the peer_autonomous_database_life_cycle_state property of a AutonomousDatabaseDataguardAssociation. + #: This constant has a value of "UNAVAILABLE" + PEER_AUTONOMOUS_DATABASE_LIFE_CYCLE_STATE_UNAVAILABLE = "UNAVAILABLE" + #: A constant which can be used with the protection_mode property of a AutonomousDatabaseDataguardAssociation. #: This constant has a value of "MAXIMUM_AVAILABILITY" PROTECTION_MODE_MAXIMUM_AVAILABILITY = "MAXIMUM_AVAILABILITY" @@ -116,7 +124,7 @@ def __init__(self, **kwargs): :param lifecycle_state: The value to assign to the lifecycle_state property of this AutonomousDatabaseDataguardAssociation. - Allowed values for this property are: "PROVISIONING", "AVAILABLE", "ROLE_CHANGE_IN_PROGRESS", "TERMINATING", "TERMINATED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "PROVISIONING", "AVAILABLE", "ROLE_CHANGE_IN_PROGRESS", "TERMINATING", "TERMINATED", "FAILED", "UNAVAILABLE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_state: str @@ -136,7 +144,7 @@ def __init__(self, **kwargs): :param peer_autonomous_database_life_cycle_state: The value to assign to the peer_autonomous_database_life_cycle_state property of this AutonomousDatabaseDataguardAssociation. - Allowed values for this property are: "PROVISIONING", "AVAILABLE", "ROLE_CHANGE_IN_PROGRESS", "TERMINATING", "TERMINATED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "PROVISIONING", "AVAILABLE", "ROLE_CHANGE_IN_PROGRESS", "TERMINATING", "TERMINATED", "FAILED", "UNAVAILABLE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type peer_autonomous_database_life_cycle_state: str @@ -311,7 +319,7 @@ def lifecycle_state(self): **[Required]** Gets the lifecycle_state of this AutonomousDatabaseDataguardAssociation. The current state of Autonomous Data Guard. - Allowed values for this property are: "PROVISIONING", "AVAILABLE", "ROLE_CHANGE_IN_PROGRESS", "TERMINATING", "TERMINATED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "PROVISIONING", "AVAILABLE", "ROLE_CHANGE_IN_PROGRESS", "TERMINATING", "TERMINATED", "FAILED", "UNAVAILABLE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -330,7 +338,7 @@ def lifecycle_state(self, lifecycle_state): :param lifecycle_state: The lifecycle_state of this AutonomousDatabaseDataguardAssociation. :type: str """ - allowed_values = ["PROVISIONING", "AVAILABLE", "ROLE_CHANGE_IN_PROGRESS", "TERMINATING", "TERMINATED", "FAILED"] + allowed_values = ["PROVISIONING", "AVAILABLE", "ROLE_CHANGE_IN_PROGRESS", "TERMINATING", "TERMINATED", "FAILED", "UNAVAILABLE"] if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._lifecycle_state = lifecycle_state @@ -423,7 +431,7 @@ def peer_autonomous_database_life_cycle_state(self): Gets the peer_autonomous_database_life_cycle_state of this AutonomousDatabaseDataguardAssociation. The current state of Autonomous Data Guard. - Allowed values for this property are: "PROVISIONING", "AVAILABLE", "ROLE_CHANGE_IN_PROGRESS", "TERMINATING", "TERMINATED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "PROVISIONING", "AVAILABLE", "ROLE_CHANGE_IN_PROGRESS", "TERMINATING", "TERMINATED", "FAILED", "UNAVAILABLE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -442,7 +450,7 @@ def peer_autonomous_database_life_cycle_state(self, peer_autonomous_database_lif :param peer_autonomous_database_life_cycle_state: The peer_autonomous_database_life_cycle_state of this AutonomousDatabaseDataguardAssociation. :type: str """ - allowed_values = ["PROVISIONING", "AVAILABLE", "ROLE_CHANGE_IN_PROGRESS", "TERMINATING", "TERMINATED", "FAILED"] + allowed_values = ["PROVISIONING", "AVAILABLE", "ROLE_CHANGE_IN_PROGRESS", "TERMINATING", "TERMINATED", "FAILED", "UNAVAILABLE"] if not value_allowed_none_or_none_sentinel(peer_autonomous_database_life_cycle_state, allowed_values): peer_autonomous_database_life_cycle_state = 'UNKNOWN_ENUM_VALUE' self._peer_autonomous_database_life_cycle_state = peer_autonomous_database_life_cycle_state diff --git a/src/oci/database/models/autonomous_database_summary.py b/src/oci/database/models/autonomous_database_summary.py index c5e4339b51..19c69b4119 100644 --- a/src/oci/database/models/autonomous_database_summary.py +++ b/src/oci/database/models/autonomous_database_summary.py @@ -364,6 +364,14 @@ def __init__(self, **kwargs): The value to assign to the whitelisted_ips property of this AutonomousDatabaseSummary. :type whitelisted_ips: list[str] + :param are_primary_whitelisted_ips_used: + The value to assign to the are_primary_whitelisted_ips_used property of this AutonomousDatabaseSummary. + :type are_primary_whitelisted_ips_used: bool + + :param standby_whitelisted_ips: + The value to assign to the standby_whitelisted_ips property of this AutonomousDatabaseSummary. + :type standby_whitelisted_ips: list[str] + :param apex_details: The value to assign to the apex_details property of this AutonomousDatabaseSummary. :type apex_details: oci.database.models.AutonomousDatabaseApex @@ -511,6 +519,8 @@ def __init__(self, **kwargs): 'db_workload': 'str', 'is_access_control_enabled': 'bool', 'whitelisted_ips': 'list[str]', + 'are_primary_whitelisted_ips_used': 'bool', + 'standby_whitelisted_ips': 'list[str]', 'apex_details': 'AutonomousDatabaseApex', 'is_auto_scaling_enabled': 'bool', 'data_safe_status': 'str', @@ -573,6 +583,8 @@ def __init__(self, **kwargs): 'db_workload': 'dbWorkload', 'is_access_control_enabled': 'isAccessControlEnabled', 'whitelisted_ips': 'whitelistedIps', + 'are_primary_whitelisted_ips_used': 'arePrimaryWhitelistedIpsUsed', + 'standby_whitelisted_ips': 'standbyWhitelistedIps', 'apex_details': 'apexDetails', 'is_auto_scaling_enabled': 'isAutoScalingEnabled', 'data_safe_status': 'dataSafeStatus', @@ -634,6 +646,8 @@ def __init__(self, **kwargs): self._db_workload = None self._is_access_control_enabled = None self._whitelisted_ips = None + self._are_primary_whitelisted_ips_used = None + self._standby_whitelisted_ips = None self._apex_details = None self._is_auto_scaling_enabled = None self._data_safe_status = None @@ -1528,7 +1542,7 @@ def db_workload(self): - OLTP - indicates an Autonomous Transaction Processing database - DW - indicates an Autonomous Data Warehouse database - AJD - indicates an Autonomous JSON Database - - APEX - indicates an Autonomous Database with the Oracle Application Express (APEX) workload type. + - APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. Allowed values for this property are: "OLTP", "DW", "AJD", "APEX", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -1548,7 +1562,7 @@ def db_workload(self, db_workload): - OLTP - indicates an Autonomous Transaction Processing database - DW - indicates an Autonomous Data Warehouse database - AJD - indicates an Autonomous JSON Database - - APEX - indicates an Autonomous Database with the Oracle Application Express (APEX) workload type. + - APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. :param db_workload: The db_workload of this AutonomousDatabaseSummary. @@ -1641,11 +1655,85 @@ def whitelisted_ips(self, whitelisted_ips): """ self._whitelisted_ips = whitelisted_ips + @property + def are_primary_whitelisted_ips_used(self): + """ + Gets the are_primary_whitelisted_ips_used of this AutonomousDatabaseSummary. + This field will be null if the Autonomous Database is not Data Guard enabled or Access Control is disabled. + It's value would be `TRUE` if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses primary IP access control list (ACL) for standby. + It's value would be `FALSE` if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses different IP access control list (ACL) for standby compared to primary. + + + :return: The are_primary_whitelisted_ips_used of this AutonomousDatabaseSummary. + :rtype: bool + """ + return self._are_primary_whitelisted_ips_used + + @are_primary_whitelisted_ips_used.setter + def are_primary_whitelisted_ips_used(self, are_primary_whitelisted_ips_used): + """ + Sets the are_primary_whitelisted_ips_used of this AutonomousDatabaseSummary. + This field will be null if the Autonomous Database is not Data Guard enabled or Access Control is disabled. + It's value would be `TRUE` if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses primary IP access control list (ACL) for standby. + It's value would be `FALSE` if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses different IP access control list (ACL) for standby compared to primary. + + + :param are_primary_whitelisted_ips_used: The are_primary_whitelisted_ips_used of this AutonomousDatabaseSummary. + :type: bool + """ + self._are_primary_whitelisted_ips_used = are_primary_whitelisted_ips_used + + @property + def standby_whitelisted_ips(self): + """ + Gets the standby_whitelisted_ips of this AutonomousDatabaseSummary. + The client IP access control list (ACL). This feature is available for autonomous databases on `shared Exadata infrastructure`__ and on Exadata Cloud@Customer. + Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. + + For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. + Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. + Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]` + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. + Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]` + + For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. + + __ https://docs.cloud.oracle.com/Content/Database/Concepts/adboverview.htm#AEI + + + :return: The standby_whitelisted_ips of this AutonomousDatabaseSummary. + :rtype: list[str] + """ + return self._standby_whitelisted_ips + + @standby_whitelisted_ips.setter + def standby_whitelisted_ips(self, standby_whitelisted_ips): + """ + Sets the standby_whitelisted_ips of this AutonomousDatabaseSummary. + The client IP access control list (ACL). This feature is available for autonomous databases on `shared Exadata infrastructure`__ and on Exadata Cloud@Customer. + Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. + + For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. + Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. + Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]` + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. + Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]` + + For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. + + __ https://docs.cloud.oracle.com/Content/Database/Concepts/adboverview.htm#AEI + + + :param standby_whitelisted_ips: The standby_whitelisted_ips of this AutonomousDatabaseSummary. + :type: list[str] + """ + self._standby_whitelisted_ips = standby_whitelisted_ips + @property def apex_details(self): """ Gets the apex_details of this AutonomousDatabaseSummary. - Information about Autonomous Application Express. + Information about Oracle APEX Application Development. :return: The apex_details of this AutonomousDatabaseSummary. @@ -1657,7 +1745,7 @@ def apex_details(self): def apex_details(self, apex_details): """ Sets the apex_details of this AutonomousDatabaseSummary. - Information about Autonomous Application Express. + Information about Oracle APEX Application Development. :param apex_details: The apex_details of this AutonomousDatabaseSummary. diff --git a/src/oci/database/models/autonomous_db_preview_version_summary.py b/src/oci/database/models/autonomous_db_preview_version_summary.py index c3db9294c1..0bac205734 100644 --- a/src/oci/database/models/autonomous_db_preview_version_summary.py +++ b/src/oci/database/models/autonomous_db_preview_version_summary.py @@ -162,7 +162,7 @@ def db_workload(self): - OLTP - indicates an Autonomous Transaction Processing database - DW - indicates an Autonomous Data Warehouse database - AJD - indicates an Autonomous JSON Database - - APEX - indicates an Autonomous Database with the Oracle Application Express (APEX) workload type. + - APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. Allowed values for this property are: "OLTP", "DW", "AJD", "APEX", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -182,7 +182,7 @@ def db_workload(self, db_workload): - OLTP - indicates an Autonomous Transaction Processing database - DW - indicates an Autonomous Data Warehouse database - AJD - indicates an Autonomous JSON Database - - APEX - indicates an Autonomous Database with the Oracle Application Express (APEX) workload type. + - APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. :param db_workload: The db_workload of this AutonomousDbPreviewVersionSummary. diff --git a/src/oci/database/models/autonomous_db_version_summary.py b/src/oci/database/models/autonomous_db_version_summary.py index c6a3793724..ad1a83c05d 100644 --- a/src/oci/database/models/autonomous_db_version_summary.py +++ b/src/oci/database/models/autonomous_db_version_summary.py @@ -133,7 +133,7 @@ def db_workload(self): - OLTP - indicates an Autonomous Transaction Processing database - DW - indicates an Autonomous Data Warehouse database - AJD - indicates an Autonomous JSON Database - - APEX - indicates an Autonomous Database with the Oracle Application Express (APEX) workload type. + - APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. Allowed values for this property are: "OLTP", "DW", "AJD", "APEX", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -153,7 +153,7 @@ def db_workload(self, db_workload): - OLTP - indicates an Autonomous Transaction Processing database - DW - indicates an Autonomous Data Warehouse database - AJD - indicates an Autonomous JSON Database - - APEX - indicates an Autonomous Database with the Oracle Application Express (APEX) workload type. + - APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. :param db_workload: The db_workload of this AutonomousDbVersionSummary. diff --git a/src/oci/database/models/create_autonomous_container_database_details.py b/src/oci/database/models/create_autonomous_container_database_details.py index 83cdc2b126..c6a5e847a5 100644 --- a/src/oci/database/models/create_autonomous_container_database_details.py +++ b/src/oci/database/models/create_autonomous_container_database_details.py @@ -84,6 +84,10 @@ def __init__(self, **kwargs): The value to assign to the peer_autonomous_container_database_backup_config property of this CreateAutonomousContainerDatabaseDetails. :type peer_autonomous_container_database_backup_config: oci.database.models.PeerAutonomousContainerDatabaseBackupConfig + :param peer_db_unique_name: + The value to assign to the peer_db_unique_name property of this CreateAutonomousContainerDatabaseDetails. + :type peer_db_unique_name: str + :param autonomous_vm_cluster_id: The value to assign to the autonomous_vm_cluster_id property of this CreateAutonomousContainerDatabaseDetails. :type autonomous_vm_cluster_id: str @@ -145,6 +149,7 @@ def __init__(self, **kwargs): 'peer_autonomous_vm_cluster_id': 'str', 'peer_autonomous_container_database_compartment_id': 'str', 'peer_autonomous_container_database_backup_config': 'PeerAutonomousContainerDatabaseBackupConfig', + 'peer_db_unique_name': 'str', 'autonomous_vm_cluster_id': 'str', 'compartment_id': 'str', 'patch_model': 'str', @@ -170,6 +175,7 @@ def __init__(self, **kwargs): 'peer_autonomous_vm_cluster_id': 'peerAutonomousVmClusterId', 'peer_autonomous_container_database_compartment_id': 'peerAutonomousContainerDatabaseCompartmentId', 'peer_autonomous_container_database_backup_config': 'peerAutonomousContainerDatabaseBackupConfig', + 'peer_db_unique_name': 'peerDbUniqueName', 'autonomous_vm_cluster_id': 'autonomousVmClusterId', 'compartment_id': 'compartmentId', 'patch_model': 'patchModel', @@ -194,6 +200,7 @@ def __init__(self, **kwargs): self._peer_autonomous_vm_cluster_id = None self._peer_autonomous_container_database_compartment_id = None self._peer_autonomous_container_database_backup_config = None + self._peer_db_unique_name = None self._autonomous_vm_cluster_id = None self._compartment_id = None self._patch_model = None @@ -477,6 +484,30 @@ def peer_autonomous_container_database_backup_config(self, peer_autonomous_conta """ self._peer_autonomous_container_database_backup_config = peer_autonomous_container_database_backup_config + @property + def peer_db_unique_name(self): + """ + Gets the peer_db_unique_name of this CreateAutonomousContainerDatabaseDetails. + The `DB_UNIQUE_NAME` of the peer Autonomous Container Database in a Data Guard association. + + + :return: The peer_db_unique_name of this CreateAutonomousContainerDatabaseDetails. + :rtype: str + """ + return self._peer_db_unique_name + + @peer_db_unique_name.setter + def peer_db_unique_name(self, peer_db_unique_name): + """ + Sets the peer_db_unique_name of this CreateAutonomousContainerDatabaseDetails. + The `DB_UNIQUE_NAME` of the peer Autonomous Container Database in a Data Guard association. + + + :param peer_db_unique_name: The peer_db_unique_name of this CreateAutonomousContainerDatabaseDetails. + :type: str + """ + self._peer_db_unique_name = peer_db_unique_name + @property def autonomous_vm_cluster_id(self): """ diff --git a/src/oci/database/models/create_autonomous_database_base.py b/src/oci/database/models/create_autonomous_database_base.py index 82c2a84ab9..4bdcfd0e4b 100644 --- a/src/oci/database/models/create_autonomous_database_base.py +++ b/src/oci/database/models/create_autonomous_database_base.py @@ -134,6 +134,14 @@ def __init__(self, **kwargs): The value to assign to the whitelisted_ips property of this CreateAutonomousDatabaseBase. :type whitelisted_ips: list[str] + :param are_primary_whitelisted_ips_used: + The value to assign to the are_primary_whitelisted_ips_used property of this CreateAutonomousDatabaseBase. + :type are_primary_whitelisted_ips_used: bool + + :param standby_whitelisted_ips: + The value to assign to the standby_whitelisted_ips property of this CreateAutonomousDatabaseBase. + :type standby_whitelisted_ips: list[str] + :param is_data_guard_enabled: The value to assign to the is_data_guard_enabled property of this CreateAutonomousDatabaseBase. :type is_data_guard_enabled: bool @@ -184,6 +192,8 @@ def __init__(self, **kwargs): 'autonomous_container_database_id': 'str', 'is_access_control_enabled': 'bool', 'whitelisted_ips': 'list[str]', + 'are_primary_whitelisted_ips_used': 'bool', + 'standby_whitelisted_ips': 'list[str]', 'is_data_guard_enabled': 'bool', 'subnet_id': 'str', 'nsg_ids': 'list[str]', @@ -210,6 +220,8 @@ def __init__(self, **kwargs): 'autonomous_container_database_id': 'autonomousContainerDatabaseId', 'is_access_control_enabled': 'isAccessControlEnabled', 'whitelisted_ips': 'whitelistedIps', + 'are_primary_whitelisted_ips_used': 'arePrimaryWhitelistedIpsUsed', + 'standby_whitelisted_ips': 'standbyWhitelistedIps', 'is_data_guard_enabled': 'isDataGuardEnabled', 'subnet_id': 'subnetId', 'nsg_ids': 'nsgIds', @@ -235,6 +247,8 @@ def __init__(self, **kwargs): self._autonomous_container_database_id = None self._is_access_control_enabled = None self._whitelisted_ips = None + self._are_primary_whitelisted_ips_used = None + self._standby_whitelisted_ips = None self._is_data_guard_enabled = None self._subnet_id = None self._nsg_ids = None @@ -354,7 +368,7 @@ def db_workload(self): - OLTP - indicates an Autonomous Transaction Processing database - DW - indicates an Autonomous Data Warehouse database - AJD - indicates an Autonomous JSON Database - - APEX - indicates an Autonomous Database with the Oracle Application Express (APEX) workload type. + - APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. Allowed values for this property are: "OLTP", "DW", "AJD", "APEX" @@ -373,7 +387,7 @@ def db_workload(self, db_workload): - OLTP - indicates an Autonomous Transaction Processing database - DW - indicates an Autonomous Data Warehouse database - AJD - indicates an Autonomous JSON Database - - APEX - indicates an Autonomous Database with the Oracle Application Express (APEX) workload type. + - APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. :param db_workload: The db_workload of this CreateAutonomousDatabaseBase. @@ -717,6 +731,80 @@ def whitelisted_ips(self, whitelisted_ips): """ self._whitelisted_ips = whitelisted_ips + @property + def are_primary_whitelisted_ips_used(self): + """ + Gets the are_primary_whitelisted_ips_used of this CreateAutonomousDatabaseBase. + This field will be null if the Autonomous Database is not Data Guard enabled or Access Control is disabled. + It's value would be `TRUE` if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses primary IP access control list (ACL) for standby. + It's value would be `FALSE` if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses different IP access control list (ACL) for standby compared to primary. + + + :return: The are_primary_whitelisted_ips_used of this CreateAutonomousDatabaseBase. + :rtype: bool + """ + return self._are_primary_whitelisted_ips_used + + @are_primary_whitelisted_ips_used.setter + def are_primary_whitelisted_ips_used(self, are_primary_whitelisted_ips_used): + """ + Sets the are_primary_whitelisted_ips_used of this CreateAutonomousDatabaseBase. + This field will be null if the Autonomous Database is not Data Guard enabled or Access Control is disabled. + It's value would be `TRUE` if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses primary IP access control list (ACL) for standby. + It's value would be `FALSE` if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses different IP access control list (ACL) for standby compared to primary. + + + :param are_primary_whitelisted_ips_used: The are_primary_whitelisted_ips_used of this CreateAutonomousDatabaseBase. + :type: bool + """ + self._are_primary_whitelisted_ips_used = are_primary_whitelisted_ips_used + + @property + def standby_whitelisted_ips(self): + """ + Gets the standby_whitelisted_ips of this CreateAutonomousDatabaseBase. + The client IP access control list (ACL). This feature is available for autonomous databases on `shared Exadata infrastructure`__ and on Exadata Cloud@Customer. + Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. + + For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. + Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. + Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]` + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. + Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]` + + For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. + + __ https://docs.cloud.oracle.com/Content/Database/Concepts/adboverview.htm#AEI + + + :return: The standby_whitelisted_ips of this CreateAutonomousDatabaseBase. + :rtype: list[str] + """ + return self._standby_whitelisted_ips + + @standby_whitelisted_ips.setter + def standby_whitelisted_ips(self, standby_whitelisted_ips): + """ + Sets the standby_whitelisted_ips of this CreateAutonomousDatabaseBase. + The client IP access control list (ACL). This feature is available for autonomous databases on `shared Exadata infrastructure`__ and on Exadata Cloud@Customer. + Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. + + For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. + Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. + Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]` + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. + Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]` + + For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. + + __ https://docs.cloud.oracle.com/Content/Database/Concepts/adboverview.htm#AEI + + + :param standby_whitelisted_ips: The standby_whitelisted_ips of this CreateAutonomousDatabaseBase. + :type: list[str] + """ + self._standby_whitelisted_ips = standby_whitelisted_ips + @property def is_data_guard_enabled(self): """ diff --git a/src/oci/database/models/create_autonomous_database_clone_details.py b/src/oci/database/models/create_autonomous_database_clone_details.py index 3a8dd242d7..1b18c6f759 100644 --- a/src/oci/database/models/create_autonomous_database_clone_details.py +++ b/src/oci/database/models/create_autonomous_database_clone_details.py @@ -89,6 +89,14 @@ def __init__(self, **kwargs): The value to assign to the whitelisted_ips property of this CreateAutonomousDatabaseCloneDetails. :type whitelisted_ips: list[str] + :param are_primary_whitelisted_ips_used: + The value to assign to the are_primary_whitelisted_ips_used property of this CreateAutonomousDatabaseCloneDetails. + :type are_primary_whitelisted_ips_used: bool + + :param standby_whitelisted_ips: + The value to assign to the standby_whitelisted_ips property of this CreateAutonomousDatabaseCloneDetails. + :type standby_whitelisted_ips: list[str] + :param is_data_guard_enabled: The value to assign to the is_data_guard_enabled property of this CreateAutonomousDatabaseCloneDetails. :type is_data_guard_enabled: bool @@ -148,6 +156,8 @@ def __init__(self, **kwargs): 'autonomous_container_database_id': 'str', 'is_access_control_enabled': 'bool', 'whitelisted_ips': 'list[str]', + 'are_primary_whitelisted_ips_used': 'bool', + 'standby_whitelisted_ips': 'list[str]', 'is_data_guard_enabled': 'bool', 'subnet_id': 'str', 'nsg_ids': 'list[str]', @@ -176,6 +186,8 @@ def __init__(self, **kwargs): 'autonomous_container_database_id': 'autonomousContainerDatabaseId', 'is_access_control_enabled': 'isAccessControlEnabled', 'whitelisted_ips': 'whitelistedIps', + 'are_primary_whitelisted_ips_used': 'arePrimaryWhitelistedIpsUsed', + 'standby_whitelisted_ips': 'standbyWhitelistedIps', 'is_data_guard_enabled': 'isDataGuardEnabled', 'subnet_id': 'subnetId', 'nsg_ids': 'nsgIds', @@ -203,6 +215,8 @@ def __init__(self, **kwargs): self._autonomous_container_database_id = None self._is_access_control_enabled = None self._whitelisted_ips = None + self._are_primary_whitelisted_ips_used = None + self._standby_whitelisted_ips = None self._is_data_guard_enabled = None self._subnet_id = None self._nsg_ids = None diff --git a/src/oci/database/models/create_autonomous_database_details.py b/src/oci/database/models/create_autonomous_database_details.py index 8b5c7bbd6c..f4867467ec 100644 --- a/src/oci/database/models/create_autonomous_database_details.py +++ b/src/oci/database/models/create_autonomous_database_details.py @@ -81,6 +81,14 @@ def __init__(self, **kwargs): The value to assign to the whitelisted_ips property of this CreateAutonomousDatabaseDetails. :type whitelisted_ips: list[str] + :param are_primary_whitelisted_ips_used: + The value to assign to the are_primary_whitelisted_ips_used property of this CreateAutonomousDatabaseDetails. + :type are_primary_whitelisted_ips_used: bool + + :param standby_whitelisted_ips: + The value to assign to the standby_whitelisted_ips property of this CreateAutonomousDatabaseDetails. + :type standby_whitelisted_ips: list[str] + :param is_data_guard_enabled: The value to assign to the is_data_guard_enabled property of this CreateAutonomousDatabaseDetails. :type is_data_guard_enabled: bool @@ -131,6 +139,8 @@ def __init__(self, **kwargs): 'autonomous_container_database_id': 'str', 'is_access_control_enabled': 'bool', 'whitelisted_ips': 'list[str]', + 'are_primary_whitelisted_ips_used': 'bool', + 'standby_whitelisted_ips': 'list[str]', 'is_data_guard_enabled': 'bool', 'subnet_id': 'str', 'nsg_ids': 'list[str]', @@ -157,6 +167,8 @@ def __init__(self, **kwargs): 'autonomous_container_database_id': 'autonomousContainerDatabaseId', 'is_access_control_enabled': 'isAccessControlEnabled', 'whitelisted_ips': 'whitelistedIps', + 'are_primary_whitelisted_ips_used': 'arePrimaryWhitelistedIpsUsed', + 'standby_whitelisted_ips': 'standbyWhitelistedIps', 'is_data_guard_enabled': 'isDataGuardEnabled', 'subnet_id': 'subnetId', 'nsg_ids': 'nsgIds', @@ -182,6 +194,8 @@ def __init__(self, **kwargs): self._autonomous_container_database_id = None self._is_access_control_enabled = None self._whitelisted_ips = None + self._are_primary_whitelisted_ips_used = None + self._standby_whitelisted_ips = None self._is_data_guard_enabled = None self._subnet_id = None self._nsg_ids = None diff --git a/src/oci/database/models/create_autonomous_database_from_backup_details.py b/src/oci/database/models/create_autonomous_database_from_backup_details.py index a4f1b86e6b..ba7a4d67f9 100644 --- a/src/oci/database/models/create_autonomous_database_from_backup_details.py +++ b/src/oci/database/models/create_autonomous_database_from_backup_details.py @@ -89,6 +89,14 @@ def __init__(self, **kwargs): The value to assign to the whitelisted_ips property of this CreateAutonomousDatabaseFromBackupDetails. :type whitelisted_ips: list[str] + :param are_primary_whitelisted_ips_used: + The value to assign to the are_primary_whitelisted_ips_used property of this CreateAutonomousDatabaseFromBackupDetails. + :type are_primary_whitelisted_ips_used: bool + + :param standby_whitelisted_ips: + The value to assign to the standby_whitelisted_ips property of this CreateAutonomousDatabaseFromBackupDetails. + :type standby_whitelisted_ips: list[str] + :param is_data_guard_enabled: The value to assign to the is_data_guard_enabled property of this CreateAutonomousDatabaseFromBackupDetails. :type is_data_guard_enabled: bool @@ -148,6 +156,8 @@ def __init__(self, **kwargs): 'autonomous_container_database_id': 'str', 'is_access_control_enabled': 'bool', 'whitelisted_ips': 'list[str]', + 'are_primary_whitelisted_ips_used': 'bool', + 'standby_whitelisted_ips': 'list[str]', 'is_data_guard_enabled': 'bool', 'subnet_id': 'str', 'nsg_ids': 'list[str]', @@ -176,6 +186,8 @@ def __init__(self, **kwargs): 'autonomous_container_database_id': 'autonomousContainerDatabaseId', 'is_access_control_enabled': 'isAccessControlEnabled', 'whitelisted_ips': 'whitelistedIps', + 'are_primary_whitelisted_ips_used': 'arePrimaryWhitelistedIpsUsed', + 'standby_whitelisted_ips': 'standbyWhitelistedIps', 'is_data_guard_enabled': 'isDataGuardEnabled', 'subnet_id': 'subnetId', 'nsg_ids': 'nsgIds', @@ -203,6 +215,8 @@ def __init__(self, **kwargs): self._autonomous_container_database_id = None self._is_access_control_enabled = None self._whitelisted_ips = None + self._are_primary_whitelisted_ips_used = None + self._standby_whitelisted_ips = None self._is_data_guard_enabled = None self._subnet_id = None self._nsg_ids = None diff --git a/src/oci/database/models/create_autonomous_database_from_backup_timestamp_details.py b/src/oci/database/models/create_autonomous_database_from_backup_timestamp_details.py index b8d77e0c22..485e47ba08 100644 --- a/src/oci/database/models/create_autonomous_database_from_backup_timestamp_details.py +++ b/src/oci/database/models/create_autonomous_database_from_backup_timestamp_details.py @@ -89,6 +89,14 @@ def __init__(self, **kwargs): The value to assign to the whitelisted_ips property of this CreateAutonomousDatabaseFromBackupTimestampDetails. :type whitelisted_ips: list[str] + :param are_primary_whitelisted_ips_used: + The value to assign to the are_primary_whitelisted_ips_used property of this CreateAutonomousDatabaseFromBackupTimestampDetails. + :type are_primary_whitelisted_ips_used: bool + + :param standby_whitelisted_ips: + The value to assign to the standby_whitelisted_ips property of this CreateAutonomousDatabaseFromBackupTimestampDetails. + :type standby_whitelisted_ips: list[str] + :param is_data_guard_enabled: The value to assign to the is_data_guard_enabled property of this CreateAutonomousDatabaseFromBackupTimestampDetails. :type is_data_guard_enabled: bool @@ -152,6 +160,8 @@ def __init__(self, **kwargs): 'autonomous_container_database_id': 'str', 'is_access_control_enabled': 'bool', 'whitelisted_ips': 'list[str]', + 'are_primary_whitelisted_ips_used': 'bool', + 'standby_whitelisted_ips': 'list[str]', 'is_data_guard_enabled': 'bool', 'subnet_id': 'str', 'nsg_ids': 'list[str]', @@ -181,6 +191,8 @@ def __init__(self, **kwargs): 'autonomous_container_database_id': 'autonomousContainerDatabaseId', 'is_access_control_enabled': 'isAccessControlEnabled', 'whitelisted_ips': 'whitelistedIps', + 'are_primary_whitelisted_ips_used': 'arePrimaryWhitelistedIpsUsed', + 'standby_whitelisted_ips': 'standbyWhitelistedIps', 'is_data_guard_enabled': 'isDataGuardEnabled', 'subnet_id': 'subnetId', 'nsg_ids': 'nsgIds', @@ -209,6 +221,8 @@ def __init__(self, **kwargs): self._autonomous_container_database_id = None self._is_access_control_enabled = None self._whitelisted_ips = None + self._are_primary_whitelisted_ips_used = None + self._standby_whitelisted_ips = None self._is_data_guard_enabled = None self._subnet_id = None self._nsg_ids = None diff --git a/src/oci/database/models/create_db_home_details.py b/src/oci/database/models/create_db_home_details.py index 116c5a6662..fb61ff6fc7 100644 --- a/src/oci/database/models/create_db_home_details.py +++ b/src/oci/database/models/create_db_home_details.py @@ -122,7 +122,7 @@ def db_version(self, db_version): def database_software_image_id(self): """ Gets the database_software_image_id of this CreateDbHomeDetails. - The database software image `OCID`__ + The database software image `OCID`__. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm @@ -136,7 +136,7 @@ def database_software_image_id(self): def database_software_image_id(self, database_software_image_id): """ Sets the database_software_image_id of this CreateDbHomeDetails. - The database software image `OCID`__ + The database software image `OCID`__. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm diff --git a/src/oci/database/models/create_refreshable_autonomous_database_clone_details.py b/src/oci/database/models/create_refreshable_autonomous_database_clone_details.py index c3b8b3b663..742e19e06c 100644 --- a/src/oci/database/models/create_refreshable_autonomous_database_clone_details.py +++ b/src/oci/database/models/create_refreshable_autonomous_database_clone_details.py @@ -89,6 +89,14 @@ def __init__(self, **kwargs): The value to assign to the whitelisted_ips property of this CreateRefreshableAutonomousDatabaseCloneDetails. :type whitelisted_ips: list[str] + :param are_primary_whitelisted_ips_used: + The value to assign to the are_primary_whitelisted_ips_used property of this CreateRefreshableAutonomousDatabaseCloneDetails. + :type are_primary_whitelisted_ips_used: bool + + :param standby_whitelisted_ips: + The value to assign to the standby_whitelisted_ips property of this CreateRefreshableAutonomousDatabaseCloneDetails. + :type standby_whitelisted_ips: list[str] + :param is_data_guard_enabled: The value to assign to the is_data_guard_enabled property of this CreateRefreshableAutonomousDatabaseCloneDetails. :type is_data_guard_enabled: bool @@ -148,6 +156,8 @@ def __init__(self, **kwargs): 'autonomous_container_database_id': 'str', 'is_access_control_enabled': 'bool', 'whitelisted_ips': 'list[str]', + 'are_primary_whitelisted_ips_used': 'bool', + 'standby_whitelisted_ips': 'list[str]', 'is_data_guard_enabled': 'bool', 'subnet_id': 'str', 'nsg_ids': 'list[str]', @@ -176,6 +186,8 @@ def __init__(self, **kwargs): 'autonomous_container_database_id': 'autonomousContainerDatabaseId', 'is_access_control_enabled': 'isAccessControlEnabled', 'whitelisted_ips': 'whitelistedIps', + 'are_primary_whitelisted_ips_used': 'arePrimaryWhitelistedIpsUsed', + 'standby_whitelisted_ips': 'standbyWhitelistedIps', 'is_data_guard_enabled': 'isDataGuardEnabled', 'subnet_id': 'subnetId', 'nsg_ids': 'nsgIds', @@ -203,6 +215,8 @@ def __init__(self, **kwargs): self._autonomous_container_database_id = None self._is_access_control_enabled = None self._whitelisted_ips = None + self._are_primary_whitelisted_ips_used = None + self._standby_whitelisted_ips = None self._is_data_guard_enabled = None self._subnet_id = None self._nsg_ids = None diff --git a/src/oci/database/models/database_software_image_summary.py b/src/oci/database/models/database_software_image_summary.py index a4791182b5..65553e632e 100644 --- a/src/oci/database/models/database_software_image_summary.py +++ b/src/oci/database/models/database_software_image_summary.py @@ -14,8 +14,7 @@ class DatabaseSoftwareImageSummary(object): 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 access control and compartments, see `Overview of the Identity Service`__. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. diff --git a/src/oci/database/models/database_upgrade_history_entry.py b/src/oci/database/models/database_upgrade_history_entry.py index 3f28b6decb..d8a0523ec9 100644 --- a/src/oci/database/models/database_upgrade_history_entry.py +++ b/src/oci/database/models/database_upgrade_history_entry.py @@ -187,7 +187,7 @@ def id(self, id): def action(self): """ **[Required]** Gets the action of this DatabaseUpgradeHistoryEntry. - action for upgrading database. + The database upgrade action. Allowed values for this property are: "PRECHECK", "UPGRADE", "ROLLBACK", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -202,7 +202,7 @@ def action(self): def action(self, action): """ Sets the action of this DatabaseUpgradeHistoryEntry. - action for upgrading database. + The database upgrade action. :param action: The action of this DatabaseUpgradeHistoryEntry. @@ -217,10 +217,12 @@ def action(self, action): def source(self): """ Gets the source of this DatabaseUpgradeHistoryEntry. - The source of the database upgrade - Use 'DB_HOME' for using existing db home to upgrade the database - Use 'DB_VERSION' for using database version to upgrade the database - Use 'DB_SOFTWARE_IMAGE' for using database software image to upgrade the database + The source of the Oracle Database software to be used for the upgrade. + - Use `DB_HOME` to specify an existing Database Home to upgrade the database. The database is moved to the target Database Home and makes use of the Oracle Database software version of the target Database Home. + - Use `DB_VERSION` to specify a generally-available Oracle Database software version to upgrade the database. + - Use `DB_SOFTWARE_IMAGE` to specify a `database software image`__ to upgrade the database. + + __ https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/databasesoftwareimage.htm Allowed values for this property are: "DB_HOME", "DB_VERSION", "DB_SOFTWARE_IMAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -235,10 +237,12 @@ def source(self): def source(self, source): """ Sets the source of this DatabaseUpgradeHistoryEntry. - The source of the database upgrade - Use 'DB_HOME' for using existing db home to upgrade the database - Use 'DB_VERSION' for using database version to upgrade the database - Use 'DB_SOFTWARE_IMAGE' for using database software image to upgrade the database + The source of the Oracle Database software to be used for the upgrade. + - Use `DB_HOME` to specify an existing Database Home to upgrade the database. The database is moved to the target Database Home and makes use of the Oracle Database software version of the target Database Home. + - Use `DB_VERSION` to specify a generally-available Oracle Database software version to upgrade the database. + - Use `DB_SOFTWARE_IMAGE` to specify a `database software image`__ to upgrade the database. + + __ https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/databasesoftwareimage.htm :param source: The source of this DatabaseUpgradeHistoryEntry. diff --git a/src/oci/database/models/database_upgrade_history_entry_summary.py b/src/oci/database/models/database_upgrade_history_entry_summary.py index a97a4c4dd6..375cff0d8d 100644 --- a/src/oci/database/models/database_upgrade_history_entry_summary.py +++ b/src/oci/database/models/database_upgrade_history_entry_summary.py @@ -187,7 +187,7 @@ def id(self, id): def action(self): """ **[Required]** Gets the action of this DatabaseUpgradeHistoryEntrySummary. - action for upgrading database. + The database upgrade action. Allowed values for this property are: "PRECHECK", "UPGRADE", "ROLLBACK", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -202,7 +202,7 @@ def action(self): def action(self, action): """ Sets the action of this DatabaseUpgradeHistoryEntrySummary. - action for upgrading database. + The database upgrade action. :param action: The action of this DatabaseUpgradeHistoryEntrySummary. @@ -217,10 +217,12 @@ def action(self, action): def source(self): """ Gets the source of this DatabaseUpgradeHistoryEntrySummary. - The source of the database upgrade - Use 'DB_HOME' for using existing db home to upgrade the database - Use 'DB_VERSION' for using database version to upgrade the database - Use 'DB_SOFTWARE_IMAGE' for using database software image to upgrade the database + The source of the Oracle Database software to be used for the upgrade. + - Use `DB_HOME` to specify an existing Database Home to upgrade the database. The database is moved to the target Database Home and makes use of the Oracle Database software version of the target Database Home. + - Use `DB_VERSION` to specify a generally-available Oracle Database software version to upgrade the database. + - Use `DB_SOFTWARE_IMAGE` to specify a `database software image`__ to upgrade the database. + + __ https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/databasesoftwareimage.htm Allowed values for this property are: "DB_HOME", "DB_VERSION", "DB_SOFTWARE_IMAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -235,10 +237,12 @@ def source(self): def source(self, source): """ Sets the source of this DatabaseUpgradeHistoryEntrySummary. - The source of the database upgrade - Use 'DB_HOME' for using existing db home to upgrade the database - Use 'DB_VERSION' for using database version to upgrade the database - Use 'DB_SOFTWARE_IMAGE' for using database software image to upgrade the database + The source of the Oracle Database software to be used for the upgrade. + - Use `DB_HOME` to specify an existing Database Home to upgrade the database. The database is moved to the target Database Home and makes use of the Oracle Database software version of the target Database Home. + - Use `DB_VERSION` to specify a generally-available Oracle Database software version to upgrade the database. + - Use `DB_SOFTWARE_IMAGE` to specify a `database software image`__ to upgrade the database. + + __ https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/databasesoftwareimage.htm :param source: The source of this DatabaseUpgradeHistoryEntrySummary. diff --git a/src/oci/database/models/database_upgrade_source_base.py b/src/oci/database/models/database_upgrade_source_base.py index 1b2dc7bfd8..3ad296971b 100644 --- a/src/oci/database/models/database_upgrade_source_base.py +++ b/src/oci/database/models/database_upgrade_source_base.py @@ -10,8 +10,7 @@ @init_model_state_from_kwargs class DatabaseUpgradeSourceBase(object): """ - Details of upgrade source using which the database is upgraded. - **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + Details for the database upgrade source. """ #: A constant which can be used with the source property of a DatabaseUpgradeSourceBase. @@ -76,10 +75,12 @@ def get_subtype(object_dictionary): def source(self): """ Gets the source of this DatabaseUpgradeSourceBase. - The source of the database upgrade - Use 'DB_HOME' for using existing db home to upgrade the database - Use 'DB_VERSION' for using database version to upgrade the database - Use 'DB_SOFTWARE_IMAGE' for using database software image to upgrade the database + The source of the Oracle Database software to be used for the upgrade. + - Use `DB_HOME` to specify an existing Database Home to upgrade the database. The database is moved to the target Database Home and makes use of the Oracle Database software version of the target Database Home. + - Use `DB_VERSION` to specify a generally-available Oracle Database software version to upgrade the database. + - Use `DB_SOFTWARE_IMAGE` to specify a `database software image`__ to upgrade the database. + + __ https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/databasesoftwareimage.htm Allowed values for this property are: "DB_HOME", "DB_VERSION", "DB_SOFTWARE_IMAGE" @@ -93,10 +94,12 @@ def source(self): def source(self, source): """ Sets the source of this DatabaseUpgradeSourceBase. - The source of the database upgrade - Use 'DB_HOME' for using existing db home to upgrade the database - Use 'DB_VERSION' for using database version to upgrade the database - Use 'DB_SOFTWARE_IMAGE' for using database software image to upgrade the database + The source of the Oracle Database software to be used for the upgrade. + - Use `DB_HOME` to specify an existing Database Home to upgrade the database. The database is moved to the target Database Home and makes use of the Oracle Database software version of the target Database Home. + - Use `DB_VERSION` to specify a generally-available Oracle Database software version to upgrade the database. + - Use `DB_SOFTWARE_IMAGE` to specify a `database software image`__ to upgrade the database. + + __ https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/databasesoftwareimage.htm :param source: The source of this DatabaseUpgradeSourceBase. diff --git a/src/oci/database/models/database_upgrade_with_database_software_image_details.py b/src/oci/database/models/database_upgrade_with_database_software_image_details.py index ff4f643a56..2d02463504 100644 --- a/src/oci/database/models/database_upgrade_with_database_software_image_details.py +++ b/src/oci/database/models/database_upgrade_with_database_software_image_details.py @@ -10,8 +10,7 @@ @init_model_state_from_kwargs class DatabaseUpgradeWithDatabaseSoftwareImageDetails(DatabaseUpgradeSourceBase): """ - Details of Database Software Image for upgrading a database. - **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + Details of the database software image to be used to upgrade a database. """ def __init__(self, **kwargs): @@ -48,7 +47,9 @@ def __init__(self, **kwargs): def database_software_image_id(self): """ **[Required]** Gets the database_software_image_id of this DatabaseUpgradeWithDatabaseSoftwareImageDetails. - the database software id used for upgrading the database. + The database software image `OCID`__ of the image to be used to upgrade a database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The database_software_image_id of this DatabaseUpgradeWithDatabaseSoftwareImageDetails. @@ -60,7 +61,9 @@ def database_software_image_id(self): def database_software_image_id(self, database_software_image_id): """ Sets the database_software_image_id of this DatabaseUpgradeWithDatabaseSoftwareImageDetails. - the database software id used for upgrading the database. + The database software image `OCID`__ of the image to be used to upgrade a database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param database_software_image_id: The database_software_image_id of this DatabaseUpgradeWithDatabaseSoftwareImageDetails. diff --git a/src/oci/database/models/database_upgrade_with_db_home_details.py b/src/oci/database/models/database_upgrade_with_db_home_details.py index 644de046e8..c467f8849b 100644 --- a/src/oci/database/models/database_upgrade_with_db_home_details.py +++ b/src/oci/database/models/database_upgrade_with_db_home_details.py @@ -10,8 +10,7 @@ @init_model_state_from_kwargs class DatabaseUpgradeWithDbHomeDetails(DatabaseUpgradeSourceBase): """ - Details of Database Home for upgrading a database. - **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + Details of Database Home to be used to upgrade a database. """ def __init__(self, **kwargs): diff --git a/src/oci/database/models/database_upgrade_with_db_version_details.py b/src/oci/database/models/database_upgrade_with_db_version_details.py index d2ac62bbbb..c022614430 100644 --- a/src/oci/database/models/database_upgrade_with_db_version_details.py +++ b/src/oci/database/models/database_upgrade_with_db_version_details.py @@ -10,8 +10,7 @@ @init_model_state_from_kwargs class DatabaseUpgradeWithDbVersionDetails(DatabaseUpgradeSourceBase): """ - Details of Database version for upgrading a database. - **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + Details of the Oracle Database software version number for upgrading a database. """ def __init__(self, **kwargs): diff --git a/src/oci/database/models/db_system_summary.py b/src/oci/database/models/db_system_summary.py index 4f34baf444..c5dfd20824 100644 --- a/src/oci/database/models/db_system_summary.py +++ b/src/oci/database/models/db_system_summary.py @@ -10,10 +10,15 @@ @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 `Bare Metal and Virtual Machine DB Systems`__. - - `Exadata DB Systems`__ - - `Bare Metal and Virtual Machine DB Systems`__ + **Note:** Deprecated for Exadata Cloud Service instances using the new `resource model`__. + To provision and manage new Exadata Cloud Service systems, use the + :class:`CloudExadataInfrastructure` and :class:`CloudVmCluster`. + See `Exadata Cloud Service`__ for more information on Exadata systems. + + For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See `Switching an Exadata DB System to the New Resource Model and APIs`__ for details on converting existing Exadata DB systems to the new resource model. 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`__. @@ -28,8 +33,10 @@ class DbSystemSummary(object): **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. - __ https://docs.cloud.oracle.com/Content/Database/Concepts/exaoverview.htm __ https://docs.cloud.oracle.com/Content/Database/Concepts/overview.htm + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model + __ https://docs.cloud.oracle.com/Content/Database/Concepts/exaoverview.htm + __ https://docs.cloud.oracle.com/Concepts/exaflexsystem_topic-resource_model_conversion.htm __ https://docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm __ https://docs.cloud.oracle.com/Content/Identity/Concepts/overview.htm __ https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm diff --git a/src/oci/database/models/update_autonomous_database_details.py b/src/oci/database/models/update_autonomous_database_details.py index b348b2b5c8..8e66b7b7a6 100644 --- a/src/oci/database/models/update_autonomous_database_details.py +++ b/src/oci/database/models/update_autonomous_database_details.py @@ -118,6 +118,14 @@ def __init__(self, **kwargs): The value to assign to the whitelisted_ips property of this UpdateAutonomousDatabaseDetails. :type whitelisted_ips: list[str] + :param are_primary_whitelisted_ips_used: + The value to assign to the are_primary_whitelisted_ips_used property of this UpdateAutonomousDatabaseDetails. + :type are_primary_whitelisted_ips_used: bool + + :param standby_whitelisted_ips: + The value to assign to the standby_whitelisted_ips property of this UpdateAutonomousDatabaseDetails. + :type standby_whitelisted_ips: list[str] + :param is_auto_scaling_enabled: The value to assign to the is_auto_scaling_enabled property of this UpdateAutonomousDatabaseDetails. :type is_auto_scaling_enabled: bool @@ -175,6 +183,8 @@ def __init__(self, **kwargs): 'license_model': 'str', 'is_access_control_enabled': 'bool', 'whitelisted_ips': 'list[str]', + 'are_primary_whitelisted_ips_used': 'bool', + 'standby_whitelisted_ips': 'list[str]', 'is_auto_scaling_enabled': 'bool', 'is_refreshable_clone': 'bool', 'refreshable_mode': 'str', @@ -200,6 +210,8 @@ def __init__(self, **kwargs): 'license_model': 'licenseModel', 'is_access_control_enabled': 'isAccessControlEnabled', 'whitelisted_ips': 'whitelistedIps', + 'are_primary_whitelisted_ips_used': 'arePrimaryWhitelistedIpsUsed', + 'standby_whitelisted_ips': 'standbyWhitelistedIps', 'is_auto_scaling_enabled': 'isAutoScalingEnabled', 'is_refreshable_clone': 'isRefreshableClone', 'refreshable_mode': 'refreshableMode', @@ -224,6 +236,8 @@ def __init__(self, **kwargs): self._license_model = None self._is_access_control_enabled = None self._whitelisted_ips = None + self._are_primary_whitelisted_ips_used = None + self._standby_whitelisted_ips = None self._is_auto_scaling_enabled = None self._is_refreshable_clone = None self._refreshable_mode = None @@ -458,7 +472,7 @@ def db_workload(self): - OLTP - indicates an Autonomous Transaction Processing database - DW - indicates an Autonomous Data Warehouse database - AJD - indicates an Autonomous JSON Database - - APEX - indicates an Autonomous Database with the Oracle Application Express (APEX) workload type. + - APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. Allowed values for this property are: "OLTP", "DW", "AJD", "APEX" @@ -477,7 +491,7 @@ def db_workload(self, db_workload): - OLTP - indicates an Autonomous Transaction Processing database - DW - indicates an Autonomous Data Warehouse database - AJD - indicates an Autonomous JSON Database - - APEX - indicates an Autonomous Database with the Oracle Application Express (APEX) workload type. + - APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. :param db_workload: The db_workload of this UpdateAutonomousDatabaseDetails. @@ -617,6 +631,80 @@ def whitelisted_ips(self, whitelisted_ips): """ self._whitelisted_ips = whitelisted_ips + @property + def are_primary_whitelisted_ips_used(self): + """ + Gets the are_primary_whitelisted_ips_used of this UpdateAutonomousDatabaseDetails. + This field will be null if the Autonomous Database is not Data Guard enabled or Access Control is disabled. + It's value would be `TRUE` if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses primary IP access control list (ACL) for standby. + It's value would be `FALSE` if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses different IP access control list (ACL) for standby compared to primary. + + + :return: The are_primary_whitelisted_ips_used of this UpdateAutonomousDatabaseDetails. + :rtype: bool + """ + return self._are_primary_whitelisted_ips_used + + @are_primary_whitelisted_ips_used.setter + def are_primary_whitelisted_ips_used(self, are_primary_whitelisted_ips_used): + """ + Sets the are_primary_whitelisted_ips_used of this UpdateAutonomousDatabaseDetails. + This field will be null if the Autonomous Database is not Data Guard enabled or Access Control is disabled. + It's value would be `TRUE` if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses primary IP access control list (ACL) for standby. + It's value would be `FALSE` if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses different IP access control list (ACL) for standby compared to primary. + + + :param are_primary_whitelisted_ips_used: The are_primary_whitelisted_ips_used of this UpdateAutonomousDatabaseDetails. + :type: bool + """ + self._are_primary_whitelisted_ips_used = are_primary_whitelisted_ips_used + + @property + def standby_whitelisted_ips(self): + """ + Gets the standby_whitelisted_ips of this UpdateAutonomousDatabaseDetails. + The client IP access control list (ACL). This feature is available for autonomous databases on `shared Exadata infrastructure`__ and on Exadata Cloud@Customer. + Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. + + For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. + Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. + Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]` + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. + Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]` + + For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. + + __ https://docs.cloud.oracle.com/Content/Database/Concepts/adboverview.htm#AEI + + + :return: The standby_whitelisted_ips of this UpdateAutonomousDatabaseDetails. + :rtype: list[str] + """ + return self._standby_whitelisted_ips + + @standby_whitelisted_ips.setter + def standby_whitelisted_ips(self, standby_whitelisted_ips): + """ + Sets the standby_whitelisted_ips of this UpdateAutonomousDatabaseDetails. + The client IP access control list (ACL). This feature is available for autonomous databases on `shared Exadata infrastructure`__ and on Exadata Cloud@Customer. + Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. + + For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. + Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. + Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]` + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. + Example: `[\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]` + + For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. + + __ https://docs.cloud.oracle.com/Content/Database/Concepts/adboverview.htm#AEI + + + :param standby_whitelisted_ips: The standby_whitelisted_ips of this UpdateAutonomousDatabaseDetails. + :type: list[str] + """ + self._standby_whitelisted_ips = standby_whitelisted_ips + @property def is_auto_scaling_enabled(self): """ diff --git a/src/oci/database/models/upgrade_database_details.py b/src/oci/database/models/upgrade_database_details.py index 265db11fbb..3de42175dc 100644 --- a/src/oci/database/models/upgrade_database_details.py +++ b/src/oci/database/models/upgrade_database_details.py @@ -10,8 +10,7 @@ @init_model_state_from_kwargs class UpgradeDatabaseDetails(object): """ - Details for upgrading a database to a specific db version. - **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + Details for upgrading a database to a specific Oracle Database version. """ #: A constant which can be used with the action property of a UpgradeDatabaseDetails. @@ -58,7 +57,7 @@ def __init__(self, **kwargs): def action(self): """ **[Required]** Gets the action of this UpgradeDatabaseDetails. - action for upgrading database. + The database upgrade action. Allowed values for this property are: "PRECHECK", "UPGRADE", "ROLLBACK" @@ -72,7 +71,7 @@ def action(self): def action(self, action): """ Sets the action of this UpgradeDatabaseDetails. - action for upgrading database. + The database upgrade action. :param action: The action of this UpgradeDatabaseDetails. diff --git a/src/oci/key_management/kms_crypto_client.py b/src/oci/key_management/kms_crypto_client.py index dc0408672f..a9d7d60279 100644 --- a/src/oci/key_management/kms_crypto_client.py +++ b/src/oci/key_management/kms_crypto_client.py @@ -347,3 +347,139 @@ def generate_data_encryption_key(self, generate_key_details, **kwargs): header_params=header_params, body=generate_key_details, response_type="GeneratedKey") + + def sign(self, sign_data_details, **kwargs): + """ + Creates a digital signature for a message or message digest by using the private key in an asymmetric key. + To verify the generated signature, you can use the Verify operation or use the public key in the same asymmetric key outside of KMS + + + :param oci.key_management.models.SignDataDetails sign_data_details: (required) + SignDataDetails + + :param str opc_request_id: (optional) + Unique identifier for the request. If provided, the returned request ID + will include this value. Otherwise, a random request ID will be + generated by the service. + + :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. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.key_management.models.SignedData` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use sign API. + """ + resource_path = "/20180608/sign" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "sign got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + header_params=header_params, + body=sign_data_details, + response_type="SignedData") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=sign_data_details, + response_type="SignedData") + + def verify(self, verify_data_details, **kwargs): + """ + Verifies a digital signature that was generated by the Sign operation using the public key in the same asymmetric key. + You can also verify the digital signature by using the public key in the asymmetric key outside of KMS + + + :param oci.key_management.models.VerifyDataDetails verify_data_details: (required) + VerifyDataDetails + + :param str opc_request_id: (optional) + Unique identifier for the request. If provided, the returned request ID + will include this value. Otherwise, a random request ID will be + generated by the service. + + :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. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.key_management.models.VerifiedData` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use verify API. + """ + resource_path = "/20180608/verify" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "verify got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + header_params=header_params, + body=verify_data_details, + response_type="VerifiedData") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=verify_data_details, + response_type="VerifiedData") diff --git a/src/oci/key_management/kms_management_client.py b/src/oci/key_management/kms_management_client.py index 2e09c51da2..3c4d28cd07 100644 --- a/src/oci/key_management/kms_management_client.py +++ b/src/oci/key_management/kms_management_client.py @@ -1491,12 +1491,17 @@ def list_keys(self, compartment_id, **kwargs): Allowed values are: "HSM", "SOFTWARE" :param str algorithm: (optional) - The algorithm used by a key's key versions to encrypt or decrypt. Currently, only AES is supported. + The algorithm used by a key's key versions to encrypt or decrypt. Currently, only AES, RSA and ECDSA are supported. - Allowed values are: "AES" + Allowed values are: "AES", "RSA", "ECDSA" :param int length: (optional) - The length of the key in bytes, expressed as an integer. Values of 16, 24, or 32 are supported. + The length of the key in bytes, expressed as an integer. Values of 16, 24, 32 are supported. + + :param str curve_id: (optional) + The curve Id of the keys in case of ECDSA keys + + Allowed values are: "NIST_P256", "NIST_P384", "NIST_P521" :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. @@ -1525,7 +1530,8 @@ def list_keys(self, compartment_id, **kwargs): "sort_order", "protection_mode", "algorithm", - "length" + "length", + "curve_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -1554,12 +1560,19 @@ def list_keys(self, compartment_id, **kwargs): ) if 'algorithm' in kwargs: - algorithm_allowed_values = ["AES"] + algorithm_allowed_values = ["AES", "RSA", "ECDSA"] if kwargs['algorithm'] not in algorithm_allowed_values: raise ValueError( "Invalid value for `algorithm`, must be one of {0}".format(algorithm_allowed_values) ) + if 'curve_id' in kwargs: + curve_id_allowed_values = ["NIST_P256", "NIST_P384", "NIST_P521"] + if kwargs['curve_id'] not in curve_id_allowed_values: + raise ValueError( + "Invalid value for `curve_id`, must be one of {0}".format(curve_id_allowed_values) + ) + query_params = { "compartmentId": compartment_id, "limit": kwargs.get("limit", missing), @@ -1568,7 +1581,8 @@ def list_keys(self, compartment_id, **kwargs): "sortOrder": kwargs.get("sort_order", missing), "protectionMode": kwargs.get("protection_mode", missing), "algorithm": kwargs.get("algorithm", missing), - "length": kwargs.get("length", missing) + "length": kwargs.get("length", missing), + "curveId": kwargs.get("curve_id", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} diff --git a/src/oci/key_management/models/__init__.py b/src/oci/key_management/models/__init__.py index 0061b6eaeb..897be3f1fd 100644 --- a/src/oci/key_management/models/__init__.py +++ b/src/oci/key_management/models/__init__.py @@ -33,11 +33,15 @@ from .schedule_key_deletion_details import ScheduleKeyDeletionDetails from .schedule_key_version_deletion_details import ScheduleKeyVersionDeletionDetails from .schedule_vault_deletion_details import ScheduleVaultDeletionDetails +from .sign_data_details import SignDataDetails +from .signed_data import SignedData from .update_key_details import UpdateKeyDetails from .update_vault_details import UpdateVaultDetails from .vault import Vault from .vault_summary import VaultSummary from .vault_usage import VaultUsage +from .verified_data import VerifiedData +from .verify_data_details import VerifyDataDetails from .wrapped_import_key import WrappedImportKey from .wrapping_key import WrappingKey @@ -72,11 +76,15 @@ "ScheduleKeyDeletionDetails": ScheduleKeyDeletionDetails, "ScheduleKeyVersionDeletionDetails": ScheduleKeyVersionDeletionDetails, "ScheduleVaultDeletionDetails": ScheduleVaultDeletionDetails, + "SignDataDetails": SignDataDetails, + "SignedData": SignedData, "UpdateKeyDetails": UpdateKeyDetails, "UpdateVaultDetails": UpdateVaultDetails, "Vault": Vault, "VaultSummary": VaultSummary, "VaultUsage": VaultUsage, + "VerifiedData": VerifiedData, + "VerifyDataDetails": VerifyDataDetails, "WrappedImportKey": WrappedImportKey, "WrappingKey": WrappingKey } diff --git a/src/oci/key_management/models/decrypt_data_details.py b/src/oci/key_management/models/decrypt_data_details.py index 31ad7b6720..f4ecb119d2 100644 --- a/src/oci/key_management/models/decrypt_data_details.py +++ b/src/oci/key_management/models/decrypt_data_details.py @@ -13,6 +13,18 @@ class DecryptDataDetails(object): DecryptDataDetails model. """ + #: A constant which can be used with the encryption_algorithm property of a DecryptDataDetails. + #: This constant has a value of "AES_256_GCM" + ENCRYPTION_ALGORITHM_AES_256_GCM = "AES_256_GCM" + + #: A constant which can be used with the encryption_algorithm property of a DecryptDataDetails. + #: This constant has a value of "RSA_OAEP_SHA_1" + ENCRYPTION_ALGORITHM_RSA_OAEP_SHA_1 = "RSA_OAEP_SHA_1" + + #: A constant which can be used with the encryption_algorithm property of a DecryptDataDetails. + #: This constant has a value of "RSA_OAEP_SHA_256" + ENCRYPTION_ALGORITHM_RSA_OAEP_SHA_256 = "RSA_OAEP_SHA_256" + def __init__(self, **kwargs): """ Initializes a new DecryptDataDetails object with values from keyword arguments. @@ -34,25 +46,40 @@ def __init__(self, **kwargs): The value to assign to the logging_context property of this DecryptDataDetails. :type logging_context: dict(str, str) + :param key_version_id: + The value to assign to the key_version_id property of this DecryptDataDetails. + :type key_version_id: str + + :param encryption_algorithm: + The value to assign to the encryption_algorithm property of this DecryptDataDetails. + Allowed values for this property are: "AES_256_GCM", "RSA_OAEP_SHA_1", "RSA_OAEP_SHA_256" + :type encryption_algorithm: str + """ self.swagger_types = { 'associated_data': 'dict(str, str)', 'ciphertext': 'str', 'key_id': 'str', - 'logging_context': 'dict(str, str)' + 'logging_context': 'dict(str, str)', + 'key_version_id': 'str', + 'encryption_algorithm': 'str' } self.attribute_map = { 'associated_data': 'associatedData', 'ciphertext': 'ciphertext', 'key_id': 'keyId', - 'logging_context': 'loggingContext' + 'logging_context': 'loggingContext', + 'key_version_id': 'keyVersionId', + 'encryption_algorithm': 'encryptionAlgorithm' } self._associated_data = None self._ciphertext = None self._key_id = None self._logging_context = None + self._key_version_id = None + self._encryption_algorithm = None @property def associated_data(self): @@ -154,6 +181,66 @@ def logging_context(self, logging_context): """ self._logging_context = logging_context + @property + def key_version_id(self): + """ + Gets the key_version_id of this DecryptDataDetails. + The OCID of the keyVersion used to encrypt the ciphertext. + + + :return: The key_version_id of this DecryptDataDetails. + :rtype: str + """ + return self._key_version_id + + @key_version_id.setter + def key_version_id(self, key_version_id): + """ + Sets the key_version_id of this DecryptDataDetails. + The OCID of the keyVersion used to encrypt the ciphertext. + + + :param key_version_id: The key_version_id of this DecryptDataDetails. + :type: str + """ + self._key_version_id = key_version_id + + @property + def encryption_algorithm(self): + """ + Gets the encryption_algorithm of this DecryptDataDetails. + Encryption algorithm to be used while encrypting/decrypting data using a customer key + AES_256_GCM is the supported value AES keys and uses GCM mode of operation + RSA_OAEP_SHA_1 and RSA_OAEP_SHA_256 are supported for RSA keys and use OAEP padding. + + Allowed values for this property are: "AES_256_GCM", "RSA_OAEP_SHA_1", "RSA_OAEP_SHA_256" + + + :return: The encryption_algorithm of this DecryptDataDetails. + :rtype: str + """ + return self._encryption_algorithm + + @encryption_algorithm.setter + def encryption_algorithm(self, encryption_algorithm): + """ + Sets the encryption_algorithm of this DecryptDataDetails. + Encryption algorithm to be used while encrypting/decrypting data using a customer key + AES_256_GCM is the supported value AES keys and uses GCM mode of operation + RSA_OAEP_SHA_1 and RSA_OAEP_SHA_256 are supported for RSA keys and use OAEP padding. + + + :param encryption_algorithm: The encryption_algorithm of this DecryptDataDetails. + :type: str + """ + allowed_values = ["AES_256_GCM", "RSA_OAEP_SHA_1", "RSA_OAEP_SHA_256"] + if not value_allowed_none_or_none_sentinel(encryption_algorithm, allowed_values): + raise ValueError( + "Invalid value for `encryption_algorithm`, must be None or one of {0}" + .format(allowed_values) + ) + self._encryption_algorithm = encryption_algorithm + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/key_management/models/decrypted_data.py b/src/oci/key_management/models/decrypted_data.py index 958686f8c8..56ed5d6bc5 100644 --- a/src/oci/key_management/models/decrypted_data.py +++ b/src/oci/key_management/models/decrypted_data.py @@ -13,6 +13,18 @@ class DecryptedData(object): DecryptedData model. """ + #: A constant which can be used with the encryption_algorithm property of a DecryptedData. + #: This constant has a value of "AES_256_GCM" + ENCRYPTION_ALGORITHM_AES_256_GCM = "AES_256_GCM" + + #: A constant which can be used with the encryption_algorithm property of a DecryptedData. + #: This constant has a value of "RSA_OAEP_SHA_1" + ENCRYPTION_ALGORITHM_RSA_OAEP_SHA_1 = "RSA_OAEP_SHA_1" + + #: A constant which can be used with the encryption_algorithm property of a DecryptedData. + #: This constant has a value of "RSA_OAEP_SHA_256" + ENCRYPTION_ALGORITHM_RSA_OAEP_SHA_256 = "RSA_OAEP_SHA_256" + def __init__(self, **kwargs): """ Initializes a new DecryptedData object with values from keyword arguments. @@ -26,19 +38,42 @@ def __init__(self, **kwargs): The value to assign to the plaintext_checksum property of this DecryptedData. :type plaintext_checksum: str + :param key_id: + The value to assign to the key_id property of this DecryptedData. + :type key_id: str + + :param key_version_id: + The value to assign to the key_version_id property of this DecryptedData. + :type key_version_id: str + + :param encryption_algorithm: + The value to assign to the encryption_algorithm property of this DecryptedData. + Allowed values for this property are: "AES_256_GCM", "RSA_OAEP_SHA_1", "RSA_OAEP_SHA_256", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type encryption_algorithm: str + """ self.swagger_types = { 'plaintext': 'str', - 'plaintext_checksum': 'str' + 'plaintext_checksum': 'str', + 'key_id': 'str', + 'key_version_id': 'str', + 'encryption_algorithm': 'str' } self.attribute_map = { 'plaintext': 'plaintext', - 'plaintext_checksum': 'plaintextChecksum' + 'plaintext_checksum': 'plaintextChecksum', + 'key_id': 'keyId', + 'key_version_id': 'keyVersionId', + 'encryption_algorithm': 'encryptionAlgorithm' } self._plaintext = None self._plaintext_checksum = None + self._key_id = None + self._key_version_id = None + self._encryption_algorithm = None @property def plaintext(self): @@ -88,6 +123,88 @@ def plaintext_checksum(self, plaintext_checksum): """ self._plaintext_checksum = plaintext_checksum + @property + def key_id(self): + """ + Gets the key_id of this DecryptedData. + The OCID of the key used to encrypt the ciphertext. + + + :return: The key_id of this DecryptedData. + :rtype: str + """ + return self._key_id + + @key_id.setter + def key_id(self, key_id): + """ + Sets the key_id of this DecryptedData. + The OCID of the key used to encrypt the ciphertext. + + + :param key_id: The key_id of this DecryptedData. + :type: str + """ + self._key_id = key_id + + @property + def key_version_id(self): + """ + Gets the key_version_id of this DecryptedData. + The OCID of the keyVersion used to encrypt the ciphertext. + + + :return: The key_version_id of this DecryptedData. + :rtype: str + """ + return self._key_version_id + + @key_version_id.setter + def key_version_id(self, key_version_id): + """ + Sets the key_version_id of this DecryptedData. + The OCID of the keyVersion used to encrypt the ciphertext. + + + :param key_version_id: The key_version_id of this DecryptedData. + :type: str + """ + self._key_version_id = key_version_id + + @property + def encryption_algorithm(self): + """ + Gets the encryption_algorithm of this DecryptedData. + Encryption algorithm to be used while encrypting/decrypting data using a customer key + AES_256_GCM is the supported value AES keys and uses GCM mode of operation + RSA_OAEP_SHA_1 and RSA_OAEP_SHA_256 are supported for RSA keys and use OAEP padding. + + Allowed values for this property are: "AES_256_GCM", "RSA_OAEP_SHA_1", "RSA_OAEP_SHA_256", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The encryption_algorithm of this DecryptedData. + :rtype: str + """ + return self._encryption_algorithm + + @encryption_algorithm.setter + def encryption_algorithm(self, encryption_algorithm): + """ + Sets the encryption_algorithm of this DecryptedData. + Encryption algorithm to be used while encrypting/decrypting data using a customer key + AES_256_GCM is the supported value AES keys and uses GCM mode of operation + RSA_OAEP_SHA_1 and RSA_OAEP_SHA_256 are supported for RSA keys and use OAEP padding. + + + :param encryption_algorithm: The encryption_algorithm of this DecryptedData. + :type: str + """ + allowed_values = ["AES_256_GCM", "RSA_OAEP_SHA_1", "RSA_OAEP_SHA_256"] + if not value_allowed_none_or_none_sentinel(encryption_algorithm, allowed_values): + encryption_algorithm = 'UNKNOWN_ENUM_VALUE' + self._encryption_algorithm = encryption_algorithm + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/key_management/models/encrypt_data_details.py b/src/oci/key_management/models/encrypt_data_details.py index 66e0d21acd..deb8a9eb93 100644 --- a/src/oci/key_management/models/encrypt_data_details.py +++ b/src/oci/key_management/models/encrypt_data_details.py @@ -13,6 +13,18 @@ class EncryptDataDetails(object): EncryptDataDetails model. """ + #: A constant which can be used with the encryption_algorithm property of a EncryptDataDetails. + #: This constant has a value of "AES_256_GCM" + ENCRYPTION_ALGORITHM_AES_256_GCM = "AES_256_GCM" + + #: A constant which can be used with the encryption_algorithm property of a EncryptDataDetails. + #: This constant has a value of "RSA_OAEP_SHA_1" + ENCRYPTION_ALGORITHM_RSA_OAEP_SHA_1 = "RSA_OAEP_SHA_1" + + #: A constant which can be used with the encryption_algorithm property of a EncryptDataDetails. + #: This constant has a value of "RSA_OAEP_SHA_256" + ENCRYPTION_ALGORITHM_RSA_OAEP_SHA_256 = "RSA_OAEP_SHA_256" + def __init__(self, **kwargs): """ Initializes a new EncryptDataDetails object with values from keyword arguments. @@ -34,25 +46,40 @@ def __init__(self, **kwargs): The value to assign to the plaintext property of this EncryptDataDetails. :type plaintext: str + :param key_version_id: + The value to assign to the key_version_id property of this EncryptDataDetails. + :type key_version_id: str + + :param encryption_algorithm: + The value to assign to the encryption_algorithm property of this EncryptDataDetails. + Allowed values for this property are: "AES_256_GCM", "RSA_OAEP_SHA_1", "RSA_OAEP_SHA_256" + :type encryption_algorithm: str + """ self.swagger_types = { 'associated_data': 'dict(str, str)', 'key_id': 'str', 'logging_context': 'dict(str, str)', - 'plaintext': 'str' + 'plaintext': 'str', + 'key_version_id': 'str', + 'encryption_algorithm': 'str' } self.attribute_map = { 'associated_data': 'associatedData', 'key_id': 'keyId', 'logging_context': 'loggingContext', - 'plaintext': 'plaintext' + 'plaintext': 'plaintext', + 'key_version_id': 'keyVersionId', + 'encryption_algorithm': 'encryptionAlgorithm' } self._associated_data = None self._key_id = None self._logging_context = None self._plaintext = None + self._key_version_id = None + self._encryption_algorithm = None @property def associated_data(self): @@ -156,6 +183,66 @@ def plaintext(self, plaintext): """ self._plaintext = plaintext + @property + def key_version_id(self): + """ + Gets the key_version_id of this EncryptDataDetails. + The OCID of the keyVersion used to encrypt the ciphertext. + + + :return: The key_version_id of this EncryptDataDetails. + :rtype: str + """ + return self._key_version_id + + @key_version_id.setter + def key_version_id(self, key_version_id): + """ + Sets the key_version_id of this EncryptDataDetails. + The OCID of the keyVersion used to encrypt the ciphertext. + + + :param key_version_id: The key_version_id of this EncryptDataDetails. + :type: str + """ + self._key_version_id = key_version_id + + @property + def encryption_algorithm(self): + """ + Gets the encryption_algorithm of this EncryptDataDetails. + Encryption algorithm to be used while encrypting/decrypting data using a customer key + AES_256_GCM is the supported value AES keys and uses GCM mode of operation + RSA_OAEP_SHA_1 and RSA_OAEP_SHA_256 are supported for RSA keys and use OAEP padding. + + Allowed values for this property are: "AES_256_GCM", "RSA_OAEP_SHA_1", "RSA_OAEP_SHA_256" + + + :return: The encryption_algorithm of this EncryptDataDetails. + :rtype: str + """ + return self._encryption_algorithm + + @encryption_algorithm.setter + def encryption_algorithm(self, encryption_algorithm): + """ + Sets the encryption_algorithm of this EncryptDataDetails. + Encryption algorithm to be used while encrypting/decrypting data using a customer key + AES_256_GCM is the supported value AES keys and uses GCM mode of operation + RSA_OAEP_SHA_1 and RSA_OAEP_SHA_256 are supported for RSA keys and use OAEP padding. + + + :param encryption_algorithm: The encryption_algorithm of this EncryptDataDetails. + :type: str + """ + allowed_values = ["AES_256_GCM", "RSA_OAEP_SHA_1", "RSA_OAEP_SHA_256"] + if not value_allowed_none_or_none_sentinel(encryption_algorithm, allowed_values): + raise ValueError( + "Invalid value for `encryption_algorithm`, must be None or one of {0}" + .format(allowed_values) + ) + self._encryption_algorithm = encryption_algorithm + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/key_management/models/encrypted_data.py b/src/oci/key_management/models/encrypted_data.py index 6e68c88334..cc44a18ede 100644 --- a/src/oci/key_management/models/encrypted_data.py +++ b/src/oci/key_management/models/encrypted_data.py @@ -13,6 +13,18 @@ class EncryptedData(object): EncryptedData model. """ + #: A constant which can be used with the encryption_algorithm property of a EncryptedData. + #: This constant has a value of "AES_256_GCM" + ENCRYPTION_ALGORITHM_AES_256_GCM = "AES_256_GCM" + + #: A constant which can be used with the encryption_algorithm property of a EncryptedData. + #: This constant has a value of "RSA_OAEP_SHA_1" + ENCRYPTION_ALGORITHM_RSA_OAEP_SHA_1 = "RSA_OAEP_SHA_1" + + #: A constant which can be used with the encryption_algorithm property of a EncryptedData. + #: This constant has a value of "RSA_OAEP_SHA_256" + ENCRYPTION_ALGORITHM_RSA_OAEP_SHA_256 = "RSA_OAEP_SHA_256" + def __init__(self, **kwargs): """ Initializes a new EncryptedData object with values from keyword arguments. @@ -22,16 +34,39 @@ def __init__(self, **kwargs): The value to assign to the ciphertext property of this EncryptedData. :type ciphertext: str + :param key_id: + The value to assign to the key_id property of this EncryptedData. + :type key_id: str + + :param key_version_id: + The value to assign to the key_version_id property of this EncryptedData. + :type key_version_id: str + + :param encryption_algorithm: + The value to assign to the encryption_algorithm property of this EncryptedData. + Allowed values for this property are: "AES_256_GCM", "RSA_OAEP_SHA_1", "RSA_OAEP_SHA_256", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type encryption_algorithm: str + """ self.swagger_types = { - 'ciphertext': 'str' + 'ciphertext': 'str', + 'key_id': 'str', + 'key_version_id': 'str', + 'encryption_algorithm': 'str' } self.attribute_map = { - 'ciphertext': 'ciphertext' + 'ciphertext': 'ciphertext', + 'key_id': 'keyId', + 'key_version_id': 'keyVersionId', + 'encryption_algorithm': 'encryptionAlgorithm' } self._ciphertext = None + self._key_id = None + self._key_version_id = None + self._encryption_algorithm = None @property def ciphertext(self): @@ -57,6 +92,88 @@ def ciphertext(self, ciphertext): """ self._ciphertext = ciphertext + @property + def key_id(self): + """ + Gets the key_id of this EncryptedData. + The OCID of the key used to sign the message + + + :return: The key_id of this EncryptedData. + :rtype: str + """ + return self._key_id + + @key_id.setter + def key_id(self, key_id): + """ + Sets the key_id of this EncryptedData. + The OCID of the key used to sign the message + + + :param key_id: The key_id of this EncryptedData. + :type: str + """ + self._key_id = key_id + + @property + def key_version_id(self): + """ + Gets the key_version_id of this EncryptedData. + The OCID of the keyVersion used to encrypt the ciphertext. + + + :return: The key_version_id of this EncryptedData. + :rtype: str + """ + return self._key_version_id + + @key_version_id.setter + def key_version_id(self, key_version_id): + """ + Sets the key_version_id of this EncryptedData. + The OCID of the keyVersion used to encrypt the ciphertext. + + + :param key_version_id: The key_version_id of this EncryptedData. + :type: str + """ + self._key_version_id = key_version_id + + @property + def encryption_algorithm(self): + """ + Gets the encryption_algorithm of this EncryptedData. + Encryption algorithm to be used while encrypting/decrypting data using a customer key + AES_256_GCM is the supported value AES keys and uses GCM mode of operation + RSA_OAEP_SHA_1 and RSA_OAEP_SHA_256 are supported for RSA keys and use OAEP padding. + + Allowed values for this property are: "AES_256_GCM", "RSA_OAEP_SHA_1", "RSA_OAEP_SHA_256", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The encryption_algorithm of this EncryptedData. + :rtype: str + """ + return self._encryption_algorithm + + @encryption_algorithm.setter + def encryption_algorithm(self, encryption_algorithm): + """ + Sets the encryption_algorithm of this EncryptedData. + Encryption algorithm to be used while encrypting/decrypting data using a customer key + AES_256_GCM is the supported value AES keys and uses GCM mode of operation + RSA_OAEP_SHA_1 and RSA_OAEP_SHA_256 are supported for RSA keys and use OAEP padding. + + + :param encryption_algorithm: The encryption_algorithm of this EncryptedData. + :type: str + """ + allowed_values = ["AES_256_GCM", "RSA_OAEP_SHA_1", "RSA_OAEP_SHA_256"] + if not value_allowed_none_or_none_sentinel(encryption_algorithm, allowed_values): + encryption_algorithm = 'UNKNOWN_ENUM_VALUE' + self._encryption_algorithm = encryption_algorithm + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/key_management/models/exported_key_data.py b/src/oci/key_management/models/exported_key_data.py index 3effc85bb7..c665738671 100644 --- a/src/oci/key_management/models/exported_key_data.py +++ b/src/oci/key_management/models/exported_key_data.py @@ -207,11 +207,11 @@ def algorithm(self): """ **[Required]** Gets the algorithm of this ExportedKeyData. The encryption algorithm to use to encrypt exportable key material from a key that persists on the server (as opposed to a key that - persists on a hardware security module and, therefore, cannot be exported). Specifying `RSA_OAEP_AES_SHA256` invokes the RSA AES key + persists on a hardware security module and, therefore, cannot be exported). Specifying RSA_OAEP_AES_SHA256 invokes the RSA AES key wrap mechanism, which generates a temporary AES key. The temporary AES key is wrapped by the RSA public wrapping key provided along with the request, creating a wrapped temporary AES key. The temporary AES key is also used to wrap the exportable key material. The wrapped temporary AES key and the wrapped exportable key material are concatenated, producing concatenated blob output that jointly - represents them. Specifying `RSA_OAEP_SHA256` means that the exportable key material is wrapped by the RSA public wrapping key provided + represents them. Specifying RSA_OAEP_SHA256 means that the exportable key material is wrapped by the RSA public wrapping key provided along with the request. Allowed values for this property are: "RSA_OAEP_AES_SHA256", "RSA_OAEP_SHA256", 'UNKNOWN_ENUM_VALUE'. @@ -228,11 +228,11 @@ def algorithm(self, algorithm): """ Sets the algorithm of this ExportedKeyData. The encryption algorithm to use to encrypt exportable key material from a key that persists on the server (as opposed to a key that - persists on a hardware security module and, therefore, cannot be exported). Specifying `RSA_OAEP_AES_SHA256` invokes the RSA AES key + persists on a hardware security module and, therefore, cannot be exported). Specifying RSA_OAEP_AES_SHA256 invokes the RSA AES key wrap mechanism, which generates a temporary AES key. The temporary AES key is wrapped by the RSA public wrapping key provided along with the request, creating a wrapped temporary AES key. The temporary AES key is also used to wrap the exportable key material. The wrapped temporary AES key and the wrapped exportable key material are concatenated, producing concatenated blob output that jointly - represents them. Specifying `RSA_OAEP_SHA256` means that the exportable key material is wrapped by the RSA public wrapping key provided + represents them. Specifying RSA_OAEP_SHA256 means that the exportable key material is wrapped by the RSA public wrapping key provided along with the request. diff --git a/src/oci/key_management/models/key_shape.py b/src/oci/key_management/models/key_shape.py index 5e45bde89e..01f26c10b6 100644 --- a/src/oci/key_management/models/key_shape.py +++ b/src/oci/key_management/models/key_shape.py @@ -21,6 +21,22 @@ class KeyShape(object): #: This constant has a value of "RSA" ALGORITHM_RSA = "RSA" + #: A constant which can be used with the algorithm property of a KeyShape. + #: This constant has a value of "ECDSA" + ALGORITHM_ECDSA = "ECDSA" + + #: A constant which can be used with the curve_id property of a KeyShape. + #: This constant has a value of "NIST_P256" + CURVE_ID_NIST_P256 = "NIST_P256" + + #: A constant which can be used with the curve_id property of a KeyShape. + #: This constant has a value of "NIST_P384" + CURVE_ID_NIST_P384 = "NIST_P384" + + #: A constant which can be used with the curve_id property of a KeyShape. + #: This constant has a value of "NIST_P521" + CURVE_ID_NIST_P521 = "NIST_P521" + def __init__(self, **kwargs): """ Initializes a new KeyShape object with values from keyword arguments. @@ -28,7 +44,7 @@ def __init__(self, **kwargs): :param algorithm: The value to assign to the algorithm property of this KeyShape. - Allowed values for this property are: "AES", "RSA", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "AES", "RSA", "ECDSA", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type algorithm: str @@ -36,19 +52,28 @@ def __init__(self, **kwargs): The value to assign to the length property of this KeyShape. :type length: int + :param curve_id: + The value to assign to the curve_id property of this KeyShape. + Allowed values for this property are: "NIST_P256", "NIST_P384", "NIST_P521", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type curve_id: str + """ self.swagger_types = { 'algorithm': 'str', - 'length': 'int' + 'length': 'int', + 'curve_id': 'str' } self.attribute_map = { 'algorithm': 'algorithm', - 'length': 'length' + 'length': 'length', + 'curve_id': 'curveId' } self._algorithm = None self._length = None + self._curve_id = None @property def algorithm(self): @@ -56,7 +81,7 @@ def algorithm(self): **[Required]** Gets the algorithm of this KeyShape. The algorithm used by a key's key versions to encrypt or decrypt. - Allowed values for this property are: "AES", "RSA", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "AES", "RSA", "ECDSA", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -75,7 +100,7 @@ def algorithm(self, algorithm): :param algorithm: The algorithm of this KeyShape. :type: str """ - allowed_values = ["AES", "RSA"] + allowed_values = ["AES", "RSA", "ECDSA"] if not value_allowed_none_or_none_sentinel(algorithm, allowed_values): algorithm = 'UNKNOWN_ENUM_VALUE' self._algorithm = algorithm @@ -84,7 +109,10 @@ def algorithm(self, algorithm): def length(self): """ **[Required]** Gets the length of this KeyShape. - The length of the key, expressed as an integer. Values of 16, 24, or 32 are supported. + The length of the key in bytes, expressed as an integer. Values supported: + - AES: 16, 24 or 32 + - RSA: 256, 384 or 512 + - ECDSA: 32, 48, 66 :return: The length of this KeyShape. @@ -96,7 +124,10 @@ def length(self): def length(self, length): """ Sets the length of this KeyShape. - The length of the key, expressed as an integer. Values of 16, 24, or 32 are supported. + The length of the key in bytes, expressed as an integer. Values supported: + - AES: 16, 24 or 32 + - RSA: 256, 384 or 512 + - ECDSA: 32, 48, 66 :param length: The length of this KeyShape. @@ -104,6 +135,36 @@ def length(self, length): """ self._length = length + @property + def curve_id(self): + """ + Gets the curve_id of this KeyShape. + Supported curve Ids for ECDSA keys + + Allowed values for this property are: "NIST_P256", "NIST_P384", "NIST_P521", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The curve_id of this KeyShape. + :rtype: str + """ + return self._curve_id + + @curve_id.setter + def curve_id(self, curve_id): + """ + Sets the curve_id of this KeyShape. + Supported curve Ids for ECDSA keys + + + :param curve_id: The curve_id of this KeyShape. + :type: str + """ + allowed_values = ["NIST_P256", "NIST_P384", "NIST_P521"] + if not value_allowed_none_or_none_sentinel(curve_id, allowed_values): + curve_id = 'UNKNOWN_ENUM_VALUE' + self._curve_id = curve_id + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/key_management/models/key_summary.py b/src/oci/key_management/models/key_summary.py index 328f22cc9e..39bf7e56c0 100644 --- a/src/oci/key_management/models/key_summary.py +++ b/src/oci/key_management/models/key_summary.py @@ -73,6 +73,18 @@ class KeySummary(object): #: This constant has a value of "SOFTWARE" PROTECTION_MODE_SOFTWARE = "SOFTWARE" + #: A constant which can be used with the algorithm property of a KeySummary. + #: This constant has a value of "AES" + ALGORITHM_AES = "AES" + + #: A constant which can be used with the algorithm property of a KeySummary. + #: This constant has a value of "RSA" + ALGORITHM_RSA = "RSA" + + #: A constant which can be used with the algorithm property of a KeySummary. + #: This constant has a value of "ECDSA" + ALGORITHM_ECDSA = "ECDSA" + def __init__(self, **kwargs): """ Initializes a new KeySummary object with values from keyword arguments. @@ -118,6 +130,12 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type protection_mode: str + :param algorithm: + The value to assign to the algorithm property of this KeySummary. + Allowed values for this property are: "AES", "RSA", "ECDSA", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type algorithm: str + """ self.swagger_types = { 'compartment_id': 'str', @@ -128,7 +146,8 @@ def __init__(self, **kwargs): 'lifecycle_state': 'str', 'time_created': 'datetime', 'vault_id': 'str', - 'protection_mode': 'str' + 'protection_mode': 'str', + 'algorithm': 'str' } self.attribute_map = { @@ -140,7 +159,8 @@ def __init__(self, **kwargs): 'lifecycle_state': 'lifecycleState', 'time_created': 'timeCreated', 'vault_id': 'vaultId', - 'protection_mode': 'protectionMode' + 'protection_mode': 'protectionMode', + 'algorithm': 'algorithm' } self._compartment_id = None @@ -152,6 +172,7 @@ def __init__(self, **kwargs): self._time_created = None self._vault_id = None self._protection_mode = None + self._algorithm = None @property def compartment_id(self): @@ -419,6 +440,36 @@ def protection_mode(self, protection_mode): protection_mode = 'UNKNOWN_ENUM_VALUE' self._protection_mode = protection_mode + @property + def algorithm(self): + """ + Gets the algorithm of this KeySummary. + The algorithm used by a key's key versions to encrypt or decrypt. + + Allowed values for this property are: "AES", "RSA", "ECDSA", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The algorithm of this KeySummary. + :rtype: str + """ + return self._algorithm + + @algorithm.setter + def algorithm(self, algorithm): + """ + Sets the algorithm of this KeySummary. + The algorithm used by a key's key versions to encrypt or decrypt. + + + :param algorithm: The algorithm of this KeySummary. + :type: str + """ + allowed_values = ["AES", "RSA", "ECDSA"] + if not value_allowed_none_or_none_sentinel(algorithm, allowed_values): + algorithm = 'UNKNOWN_ENUM_VALUE' + self._algorithm = algorithm + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/key_management/models/key_version.py b/src/oci/key_management/models/key_version.py index 000260a706..660c00125f 100644 --- a/src/oci/key_management/models/key_version.py +++ b/src/oci/key_management/models/key_version.py @@ -78,6 +78,10 @@ def __init__(self, **kwargs): The value to assign to the key_id property of this KeyVersion. :type key_id: str + :param public_key: + The value to assign to the public_key property of this KeyVersion. + :type public_key: str + :param lifecycle_state: The value to assign to the lifecycle_state property of this KeyVersion. Allowed values for this property are: "CREATING", "ENABLING", "ENABLED", "DISABLING", "DISABLED", "DELETING", "DELETED", "PENDING_DELETION", "SCHEDULING_DELETION", "CANCELLING_DELETION", 'UNKNOWN_ENUM_VALUE'. @@ -111,6 +115,7 @@ def __init__(self, **kwargs): 'compartment_id': 'str', 'id': 'str', 'key_id': 'str', + 'public_key': 'str', 'lifecycle_state': 'str', 'origin': 'str', 'time_created': 'datetime', @@ -123,6 +128,7 @@ def __init__(self, **kwargs): 'compartment_id': 'compartmentId', 'id': 'id', 'key_id': 'keyId', + 'public_key': 'publicKey', 'lifecycle_state': 'lifecycleState', 'origin': 'origin', 'time_created': 'timeCreated', @@ -134,6 +140,7 @@ def __init__(self, **kwargs): self._compartment_id = None self._id = None self._key_id = None + self._public_key = None self._lifecycle_state = None self._origin = None self._time_created = None @@ -213,6 +220,30 @@ def key_id(self, key_id): """ self._key_id = key_id + @property + def public_key(self): + """ + Gets the public_key of this KeyVersion. + The public key in PEM format which will be populated only in case of RSA and ECDSA keys. + + + :return: The public_key of this KeyVersion. + :rtype: str + """ + return self._public_key + + @public_key.setter + def public_key(self, public_key): + """ + Sets the public_key of this KeyVersion. + The public key in PEM format which will be populated only in case of RSA and ECDSA keys. + + + :param public_key: The public_key of this KeyVersion. + :type: str + """ + self._public_key = public_key + @property def lifecycle_state(self): """ diff --git a/src/oci/key_management/models/sign_data_details.py b/src/oci/key_management/models/sign_data_details.py new file mode 100644 index 0000000000..f78c9ba7db --- /dev/null +++ b/src/oci/key_management/models/sign_data_details.py @@ -0,0 +1,276 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class SignDataDetails(object): + """ + SignDataDetails model. + """ + + #: A constant which can be used with the message_type property of a SignDataDetails. + #: This constant has a value of "RAW" + MESSAGE_TYPE_RAW = "RAW" + + #: A constant which can be used with the message_type property of a SignDataDetails. + #: This constant has a value of "DIGEST" + MESSAGE_TYPE_DIGEST = "DIGEST" + + #: A constant which can be used with the signing_algorithm property of a SignDataDetails. + #: This constant has a value of "SHA_224_RSA_PKCS_PSS" + SIGNING_ALGORITHM_SHA_224_RSA_PKCS_PSS = "SHA_224_RSA_PKCS_PSS" + + #: A constant which can be used with the signing_algorithm property of a SignDataDetails. + #: This constant has a value of "SHA_256_RSA_PKCS_PSS" + SIGNING_ALGORITHM_SHA_256_RSA_PKCS_PSS = "SHA_256_RSA_PKCS_PSS" + + #: A constant which can be used with the signing_algorithm property of a SignDataDetails. + #: This constant has a value of "SHA_384_RSA_PKCS_PSS" + SIGNING_ALGORITHM_SHA_384_RSA_PKCS_PSS = "SHA_384_RSA_PKCS_PSS" + + #: A constant which can be used with the signing_algorithm property of a SignDataDetails. + #: This constant has a value of "SHA_512_RSA_PKCS_PSS" + SIGNING_ALGORITHM_SHA_512_RSA_PKCS_PSS = "SHA_512_RSA_PKCS_PSS" + + #: A constant which can be used with the signing_algorithm property of a SignDataDetails. + #: This constant has a value of "SHA_224_RSA_PKCS1_V1_5" + SIGNING_ALGORITHM_SHA_224_RSA_PKCS1_V1_5 = "SHA_224_RSA_PKCS1_V1_5" + + #: A constant which can be used with the signing_algorithm property of a SignDataDetails. + #: This constant has a value of "SHA_256_RSA_PKCS1_V1_5" + SIGNING_ALGORITHM_SHA_256_RSA_PKCS1_V1_5 = "SHA_256_RSA_PKCS1_V1_5" + + #: A constant which can be used with the signing_algorithm property of a SignDataDetails. + #: This constant has a value of "SHA_384_RSA_PKCS1_V1_5" + SIGNING_ALGORITHM_SHA_384_RSA_PKCS1_V1_5 = "SHA_384_RSA_PKCS1_V1_5" + + #: A constant which can be used with the signing_algorithm property of a SignDataDetails. + #: This constant has a value of "SHA_512_RSA_PKCS1_V1_5" + SIGNING_ALGORITHM_SHA_512_RSA_PKCS1_V1_5 = "SHA_512_RSA_PKCS1_V1_5" + + #: A constant which can be used with the signing_algorithm property of a SignDataDetails. + #: This constant has a value of "ECDSA_SHA_256" + SIGNING_ALGORITHM_ECDSA_SHA_256 = "ECDSA_SHA_256" + + #: A constant which can be used with the signing_algorithm property of a SignDataDetails. + #: This constant has a value of "ECDSA_SHA_384" + SIGNING_ALGORITHM_ECDSA_SHA_384 = "ECDSA_SHA_384" + + #: A constant which can be used with the signing_algorithm property of a SignDataDetails. + #: This constant has a value of "ECDSA_SHA_512" + SIGNING_ALGORITHM_ECDSA_SHA_512 = "ECDSA_SHA_512" + + def __init__(self, **kwargs): + """ + Initializes a new SignDataDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param message: + The value to assign to the message property of this SignDataDetails. + :type message: str + + :param key_id: + The value to assign to the key_id property of this SignDataDetails. + :type key_id: str + + :param key_version_id: + The value to assign to the key_version_id property of this SignDataDetails. + :type key_version_id: str + + :param message_type: + The value to assign to the message_type property of this SignDataDetails. + Allowed values for this property are: "RAW", "DIGEST" + :type message_type: str + + :param signing_algorithm: + The value to assign to the signing_algorithm property of this SignDataDetails. + Allowed values for this property are: "SHA_224_RSA_PKCS_PSS", "SHA_256_RSA_PKCS_PSS", "SHA_384_RSA_PKCS_PSS", "SHA_512_RSA_PKCS_PSS", "SHA_224_RSA_PKCS1_V1_5", "SHA_256_RSA_PKCS1_V1_5", "SHA_384_RSA_PKCS1_V1_5", "SHA_512_RSA_PKCS1_V1_5", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512" + :type signing_algorithm: str + + """ + self.swagger_types = { + 'message': 'str', + 'key_id': 'str', + 'key_version_id': 'str', + 'message_type': 'str', + 'signing_algorithm': 'str' + } + + self.attribute_map = { + 'message': 'message', + 'key_id': 'keyId', + 'key_version_id': 'keyVersionId', + 'message_type': 'messageType', + 'signing_algorithm': 'signingAlgorithm' + } + + self._message = None + self._key_id = None + self._key_version_id = None + self._message_type = None + self._signing_algorithm = None + + @property + def message(self): + """ + **[Required]** Gets the message of this SignDataDetails. + The Base64-encoded binary data object denoting the message or message digest to be signed. Message can be upto 4096 size in bytes. To sign a larger message, provide the message digest. + + + :return: The message of this SignDataDetails. + :rtype: str + """ + return self._message + + @message.setter + def message(self, message): + """ + Sets the message of this SignDataDetails. + The Base64-encoded binary data object denoting the message or message digest to be signed. Message can be upto 4096 size in bytes. To sign a larger message, provide the message digest. + + + :param message: The message of this SignDataDetails. + :type: str + """ + self._message = message + + @property + def key_id(self): + """ + **[Required]** Gets the key_id of this SignDataDetails. + The OCID of the key used to sign the message + + + :return: The key_id of this SignDataDetails. + :rtype: str + """ + return self._key_id + + @key_id.setter + def key_id(self, key_id): + """ + Sets the key_id of this SignDataDetails. + The OCID of the key used to sign the message + + + :param key_id: The key_id of this SignDataDetails. + :type: str + """ + self._key_id = key_id + + @property + def key_version_id(self): + """ + Gets the key_version_id of this SignDataDetails. + The OCID of the keyVersion used to sign the message. + + + :return: The key_version_id of this SignDataDetails. + :rtype: str + """ + return self._key_version_id + + @key_version_id.setter + def key_version_id(self, key_version_id): + """ + Sets the key_version_id of this SignDataDetails. + The OCID of the keyVersion used to sign the message. + + + :param key_version_id: The key_version_id of this SignDataDetails. + :type: str + """ + self._key_version_id = key_version_id + + @property + def message_type(self): + """ + Gets the message_type of this SignDataDetails. + Denotes whether the value of the message parameter is a raw message or a message digest. + The default value, RAW, indicates a message. To indicate a message digest, use DIGEST. + + Allowed values for this property are: "RAW", "DIGEST" + + + :return: The message_type of this SignDataDetails. + :rtype: str + """ + return self._message_type + + @message_type.setter + def message_type(self, message_type): + """ + Sets the message_type of this SignDataDetails. + Denotes whether the value of the message parameter is a raw message or a message digest. + The default value, RAW, indicates a message. To indicate a message digest, use DIGEST. + + + :param message_type: The message_type of this SignDataDetails. + :type: str + """ + allowed_values = ["RAW", "DIGEST"] + if not value_allowed_none_or_none_sentinel(message_type, allowed_values): + raise ValueError( + "Invalid value for `message_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._message_type = message_type + + @property + def signing_algorithm(self): + """ + **[Required]** Gets the signing_algorithm of this SignDataDetails. + The algorithm to be used for signing the message or message digest + For RSA keys, there are two supported Signature Schemes: PKCS1 and PSS along with + different Hashing algorithms. + For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms. + In case of passing digest for signing, make sure the same hashing algorithm is + specified as used for created for digest. + + Allowed values for this property are: "SHA_224_RSA_PKCS_PSS", "SHA_256_RSA_PKCS_PSS", "SHA_384_RSA_PKCS_PSS", "SHA_512_RSA_PKCS_PSS", "SHA_224_RSA_PKCS1_V1_5", "SHA_256_RSA_PKCS1_V1_5", "SHA_384_RSA_PKCS1_V1_5", "SHA_512_RSA_PKCS1_V1_5", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512" + + + :return: The signing_algorithm of this SignDataDetails. + :rtype: str + """ + return self._signing_algorithm + + @signing_algorithm.setter + def signing_algorithm(self, signing_algorithm): + """ + Sets the signing_algorithm of this SignDataDetails. + The algorithm to be used for signing the message or message digest + For RSA keys, there are two supported Signature Schemes: PKCS1 and PSS along with + different Hashing algorithms. + For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms. + In case of passing digest for signing, make sure the same hashing algorithm is + specified as used for created for digest. + + + :param signing_algorithm: The signing_algorithm of this SignDataDetails. + :type: str + """ + allowed_values = ["SHA_224_RSA_PKCS_PSS", "SHA_256_RSA_PKCS_PSS", "SHA_384_RSA_PKCS_PSS", "SHA_512_RSA_PKCS_PSS", "SHA_224_RSA_PKCS1_V1_5", "SHA_256_RSA_PKCS1_V1_5", "SHA_384_RSA_PKCS1_V1_5", "SHA_512_RSA_PKCS1_V1_5", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512"] + if not value_allowed_none_or_none_sentinel(signing_algorithm, allowed_values): + raise ValueError( + "Invalid value for `signing_algorithm`, must be None or one of {0}" + .format(allowed_values) + ) + self._signing_algorithm = signing_algorithm + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/key_management/models/signed_data.py b/src/oci/key_management/models/signed_data.py new file mode 100644 index 0000000000..bba6090189 --- /dev/null +++ b/src/oci/key_management/models/signed_data.py @@ -0,0 +1,225 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class SignedData(object): + """ + SignedData model. + """ + + #: A constant which can be used with the signing_algorithm property of a SignedData. + #: This constant has a value of "SHA_224_RSA_PKCS_PSS" + SIGNING_ALGORITHM_SHA_224_RSA_PKCS_PSS = "SHA_224_RSA_PKCS_PSS" + + #: A constant which can be used with the signing_algorithm property of a SignedData. + #: This constant has a value of "SHA_256_RSA_PKCS_PSS" + SIGNING_ALGORITHM_SHA_256_RSA_PKCS_PSS = "SHA_256_RSA_PKCS_PSS" + + #: A constant which can be used with the signing_algorithm property of a SignedData. + #: This constant has a value of "SHA_384_RSA_PKCS_PSS" + SIGNING_ALGORITHM_SHA_384_RSA_PKCS_PSS = "SHA_384_RSA_PKCS_PSS" + + #: A constant which can be used with the signing_algorithm property of a SignedData. + #: This constant has a value of "SHA_512_RSA_PKCS_PSS" + SIGNING_ALGORITHM_SHA_512_RSA_PKCS_PSS = "SHA_512_RSA_PKCS_PSS" + + #: A constant which can be used with the signing_algorithm property of a SignedData. + #: This constant has a value of "SHA_224_RSA_PKCS1_V1_5" + SIGNING_ALGORITHM_SHA_224_RSA_PKCS1_V1_5 = "SHA_224_RSA_PKCS1_V1_5" + + #: A constant which can be used with the signing_algorithm property of a SignedData. + #: This constant has a value of "SHA_256_RSA_PKCS1_V1_5" + SIGNING_ALGORITHM_SHA_256_RSA_PKCS1_V1_5 = "SHA_256_RSA_PKCS1_V1_5" + + #: A constant which can be used with the signing_algorithm property of a SignedData. + #: This constant has a value of "SHA_384_RSA_PKCS1_V1_5" + SIGNING_ALGORITHM_SHA_384_RSA_PKCS1_V1_5 = "SHA_384_RSA_PKCS1_V1_5" + + #: A constant which can be used with the signing_algorithm property of a SignedData. + #: This constant has a value of "SHA_512_RSA_PKCS1_V1_5" + SIGNING_ALGORITHM_SHA_512_RSA_PKCS1_V1_5 = "SHA_512_RSA_PKCS1_V1_5" + + #: A constant which can be used with the signing_algorithm property of a SignedData. + #: This constant has a value of "ECDSA_SHA_256" + SIGNING_ALGORITHM_ECDSA_SHA_256 = "ECDSA_SHA_256" + + #: A constant which can be used with the signing_algorithm property of a SignedData. + #: This constant has a value of "ECDSA_SHA_384" + SIGNING_ALGORITHM_ECDSA_SHA_384 = "ECDSA_SHA_384" + + #: A constant which can be used with the signing_algorithm property of a SignedData. + #: This constant has a value of "ECDSA_SHA_512" + SIGNING_ALGORITHM_ECDSA_SHA_512 = "ECDSA_SHA_512" + + def __init__(self, **kwargs): + """ + Initializes a new SignedData object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param key_id: + The value to assign to the key_id property of this SignedData. + :type key_id: str + + :param key_version_id: + The value to assign to the key_version_id property of this SignedData. + :type key_version_id: str + + :param signature: + The value to assign to the signature property of this SignedData. + :type signature: str + + :param signing_algorithm: + The value to assign to the signing_algorithm property of this SignedData. + Allowed values for this property are: "SHA_224_RSA_PKCS_PSS", "SHA_256_RSA_PKCS_PSS", "SHA_384_RSA_PKCS_PSS", "SHA_512_RSA_PKCS_PSS", "SHA_224_RSA_PKCS1_V1_5", "SHA_256_RSA_PKCS1_V1_5", "SHA_384_RSA_PKCS1_V1_5", "SHA_512_RSA_PKCS1_V1_5", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type signing_algorithm: str + + """ + self.swagger_types = { + 'key_id': 'str', + 'key_version_id': 'str', + 'signature': 'str', + 'signing_algorithm': 'str' + } + + self.attribute_map = { + 'key_id': 'keyId', + 'key_version_id': 'keyVersionId', + 'signature': 'signature', + 'signing_algorithm': 'signingAlgorithm' + } + + self._key_id = None + self._key_version_id = None + self._signature = None + self._signing_algorithm = None + + @property + def key_id(self): + """ + **[Required]** Gets the key_id of this SignedData. + The OCID of the key used to sign the message + + + :return: The key_id of this SignedData. + :rtype: str + """ + return self._key_id + + @key_id.setter + def key_id(self, key_id): + """ + Sets the key_id of this SignedData. + The OCID of the key used to sign the message + + + :param key_id: The key_id of this SignedData. + :type: str + """ + self._key_id = key_id + + @property + def key_version_id(self): + """ + **[Required]** Gets the key_version_id of this SignedData. + The OCID of the keyVersion used to sign the message + + + :return: The key_version_id of this SignedData. + :rtype: str + """ + return self._key_version_id + + @key_version_id.setter + def key_version_id(self, key_version_id): + """ + Sets the key_version_id of this SignedData. + The OCID of the keyVersion used to sign the message + + + :param key_version_id: The key_version_id of this SignedData. + :type: str + """ + self._key_version_id = key_version_id + + @property + def signature(self): + """ + **[Required]** Gets the signature of this SignedData. + The Base64-encoded binary data object denoting the cryptographic signature that was generated for the message or message digest. + + + :return: The signature of this SignedData. + :rtype: str + """ + return self._signature + + @signature.setter + def signature(self, signature): + """ + Sets the signature of this SignedData. + The Base64-encoded binary data object denoting the cryptographic signature that was generated for the message or message digest. + + + :param signature: The signature of this SignedData. + :type: str + """ + self._signature = signature + + @property + def signing_algorithm(self): + """ + **[Required]** Gets the signing_algorithm of this SignedData. + The algorithm to be used for signing the message or message digest + For RSA keys, there are two supported Signature Schemes: PKCS1 and PSS along with + different Hashing algorithms. + For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms. + In case of passing digest for signing, make sure the same hashing algorithm is + specified as used for created for digest. + + Allowed values for this property are: "SHA_224_RSA_PKCS_PSS", "SHA_256_RSA_PKCS_PSS", "SHA_384_RSA_PKCS_PSS", "SHA_512_RSA_PKCS_PSS", "SHA_224_RSA_PKCS1_V1_5", "SHA_256_RSA_PKCS1_V1_5", "SHA_384_RSA_PKCS1_V1_5", "SHA_512_RSA_PKCS1_V1_5", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The signing_algorithm of this SignedData. + :rtype: str + """ + return self._signing_algorithm + + @signing_algorithm.setter + def signing_algorithm(self, signing_algorithm): + """ + Sets the signing_algorithm of this SignedData. + The algorithm to be used for signing the message or message digest + For RSA keys, there are two supported Signature Schemes: PKCS1 and PSS along with + different Hashing algorithms. + For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms. + In case of passing digest for signing, make sure the same hashing algorithm is + specified as used for created for digest. + + + :param signing_algorithm: The signing_algorithm of this SignedData. + :type: str + """ + allowed_values = ["SHA_224_RSA_PKCS_PSS", "SHA_256_RSA_PKCS_PSS", "SHA_384_RSA_PKCS_PSS", "SHA_512_RSA_PKCS_PSS", "SHA_224_RSA_PKCS1_V1_5", "SHA_256_RSA_PKCS1_V1_5", "SHA_384_RSA_PKCS1_V1_5", "SHA_512_RSA_PKCS1_V1_5", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512"] + if not value_allowed_none_or_none_sentinel(signing_algorithm, allowed_values): + signing_algorithm = 'UNKNOWN_ENUM_VALUE' + self._signing_algorithm = signing_algorithm + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/key_management/models/verified_data.py b/src/oci/key_management/models/verified_data.py new file mode 100644 index 0000000000..10ac73e995 --- /dev/null +++ b/src/oci/key_management/models/verified_data.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VerifiedData(object): + """ + VerifiedData model. + """ + + def __init__(self, **kwargs): + """ + Initializes a new VerifiedData object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param is_signature_valid: + The value to assign to the is_signature_valid property of this VerifiedData. + :type is_signature_valid: bool + + """ + self.swagger_types = { + 'is_signature_valid': 'bool' + } + + self.attribute_map = { + 'is_signature_valid': 'isSignatureValid' + } + + self._is_signature_valid = None + + @property + def is_signature_valid(self): + """ + **[Required]** Gets the is_signature_valid of this VerifiedData. + A Boolean value that indicates whether the signature was verified. + + + :return: The is_signature_valid of this VerifiedData. + :rtype: bool + """ + return self._is_signature_valid + + @is_signature_valid.setter + def is_signature_valid(self, is_signature_valid): + """ + Sets the is_signature_valid of this VerifiedData. + A Boolean value that indicates whether the signature was verified. + + + :param is_signature_valid: The is_signature_valid of this VerifiedData. + :type: bool + """ + self._is_signature_valid = is_signature_valid + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/key_management/models/verify_data_details.py b/src/oci/key_management/models/verify_data_details.py new file mode 100644 index 0000000000..c7cc50ab06 --- /dev/null +++ b/src/oci/key_management/models/verify_data_details.py @@ -0,0 +1,305 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VerifyDataDetails(object): + """ + VerifyDataDetails model. + """ + + #: A constant which can be used with the message_type property of a VerifyDataDetails. + #: This constant has a value of "RAW" + MESSAGE_TYPE_RAW = "RAW" + + #: A constant which can be used with the message_type property of a VerifyDataDetails. + #: This constant has a value of "DIGEST" + MESSAGE_TYPE_DIGEST = "DIGEST" + + #: A constant which can be used with the signing_algorithm property of a VerifyDataDetails. + #: This constant has a value of "SHA_224_RSA_PKCS_PSS" + SIGNING_ALGORITHM_SHA_224_RSA_PKCS_PSS = "SHA_224_RSA_PKCS_PSS" + + #: A constant which can be used with the signing_algorithm property of a VerifyDataDetails. + #: This constant has a value of "SHA_256_RSA_PKCS_PSS" + SIGNING_ALGORITHM_SHA_256_RSA_PKCS_PSS = "SHA_256_RSA_PKCS_PSS" + + #: A constant which can be used with the signing_algorithm property of a VerifyDataDetails. + #: This constant has a value of "SHA_384_RSA_PKCS_PSS" + SIGNING_ALGORITHM_SHA_384_RSA_PKCS_PSS = "SHA_384_RSA_PKCS_PSS" + + #: A constant which can be used with the signing_algorithm property of a VerifyDataDetails. + #: This constant has a value of "SHA_512_RSA_PKCS_PSS" + SIGNING_ALGORITHM_SHA_512_RSA_PKCS_PSS = "SHA_512_RSA_PKCS_PSS" + + #: A constant which can be used with the signing_algorithm property of a VerifyDataDetails. + #: This constant has a value of "SHA_224_RSA_PKCS1_V1_5" + SIGNING_ALGORITHM_SHA_224_RSA_PKCS1_V1_5 = "SHA_224_RSA_PKCS1_V1_5" + + #: A constant which can be used with the signing_algorithm property of a VerifyDataDetails. + #: This constant has a value of "SHA_256_RSA_PKCS1_V1_5" + SIGNING_ALGORITHM_SHA_256_RSA_PKCS1_V1_5 = "SHA_256_RSA_PKCS1_V1_5" + + #: A constant which can be used with the signing_algorithm property of a VerifyDataDetails. + #: This constant has a value of "SHA_384_RSA_PKCS1_V1_5" + SIGNING_ALGORITHM_SHA_384_RSA_PKCS1_V1_5 = "SHA_384_RSA_PKCS1_V1_5" + + #: A constant which can be used with the signing_algorithm property of a VerifyDataDetails. + #: This constant has a value of "SHA_512_RSA_PKCS1_V1_5" + SIGNING_ALGORITHM_SHA_512_RSA_PKCS1_V1_5 = "SHA_512_RSA_PKCS1_V1_5" + + #: A constant which can be used with the signing_algorithm property of a VerifyDataDetails. + #: This constant has a value of "ECDSA_SHA_256" + SIGNING_ALGORITHM_ECDSA_SHA_256 = "ECDSA_SHA_256" + + #: A constant which can be used with the signing_algorithm property of a VerifyDataDetails. + #: This constant has a value of "ECDSA_SHA_384" + SIGNING_ALGORITHM_ECDSA_SHA_384 = "ECDSA_SHA_384" + + #: A constant which can be used with the signing_algorithm property of a VerifyDataDetails. + #: This constant has a value of "ECDSA_SHA_512" + SIGNING_ALGORITHM_ECDSA_SHA_512 = "ECDSA_SHA_512" + + def __init__(self, **kwargs): + """ + Initializes a new VerifyDataDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param key_id: + The value to assign to the key_id property of this VerifyDataDetails. + :type key_id: str + + :param key_version_id: + The value to assign to the key_version_id property of this VerifyDataDetails. + :type key_version_id: str + + :param signature: + The value to assign to the signature property of this VerifyDataDetails. + :type signature: str + + :param message_type: + The value to assign to the message_type property of this VerifyDataDetails. + Allowed values for this property are: "RAW", "DIGEST" + :type message_type: str + + :param message: + The value to assign to the message property of this VerifyDataDetails. + :type message: str + + :param signing_algorithm: + The value to assign to the signing_algorithm property of this VerifyDataDetails. + Allowed values for this property are: "SHA_224_RSA_PKCS_PSS", "SHA_256_RSA_PKCS_PSS", "SHA_384_RSA_PKCS_PSS", "SHA_512_RSA_PKCS_PSS", "SHA_224_RSA_PKCS1_V1_5", "SHA_256_RSA_PKCS1_V1_5", "SHA_384_RSA_PKCS1_V1_5", "SHA_512_RSA_PKCS1_V1_5", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512" + :type signing_algorithm: str + + """ + self.swagger_types = { + 'key_id': 'str', + 'key_version_id': 'str', + 'signature': 'str', + 'message_type': 'str', + 'message': 'str', + 'signing_algorithm': 'str' + } + + self.attribute_map = { + 'key_id': 'keyId', + 'key_version_id': 'keyVersionId', + 'signature': 'signature', + 'message_type': 'messageType', + 'message': 'message', + 'signing_algorithm': 'signingAlgorithm' + } + + self._key_id = None + self._key_version_id = None + self._signature = None + self._message_type = None + self._message = None + self._signing_algorithm = None + + @property + def key_id(self): + """ + **[Required]** Gets the key_id of this VerifyDataDetails. + The OCID of the key used to sign the message + + + :return: The key_id of this VerifyDataDetails. + :rtype: str + """ + return self._key_id + + @key_id.setter + def key_id(self, key_id): + """ + Sets the key_id of this VerifyDataDetails. + The OCID of the key used to sign the message + + + :param key_id: The key_id of this VerifyDataDetails. + :type: str + """ + self._key_id = key_id + + @property + def key_version_id(self): + """ + **[Required]** Gets the key_version_id of this VerifyDataDetails. + The OCID of the keyVersion used to sign the message + + + :return: The key_version_id of this VerifyDataDetails. + :rtype: str + """ + return self._key_version_id + + @key_version_id.setter + def key_version_id(self, key_version_id): + """ + Sets the key_version_id of this VerifyDataDetails. + The OCID of the keyVersion used to sign the message + + + :param key_version_id: The key_version_id of this VerifyDataDetails. + :type: str + """ + self._key_version_id = key_version_id + + @property + def signature(self): + """ + **[Required]** Gets the signature of this VerifyDataDetails. + The Base64-encoded binary data object denoting the cryptographic signature that was generated for the message. + + + :return: The signature of this VerifyDataDetails. + :rtype: str + """ + return self._signature + + @signature.setter + def signature(self, signature): + """ + Sets the signature of this VerifyDataDetails. + The Base64-encoded binary data object denoting the cryptographic signature that was generated for the message. + + + :param signature: The signature of this VerifyDataDetails. + :type: str + """ + self._signature = signature + + @property + def message_type(self): + """ + Gets the message_type of this VerifyDataDetails. + Denotes whether the value of the message parameter is a raw message or a message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST. + + Allowed values for this property are: "RAW", "DIGEST" + + + :return: The message_type of this VerifyDataDetails. + :rtype: str + """ + return self._message_type + + @message_type.setter + def message_type(self, message_type): + """ + Sets the message_type of this VerifyDataDetails. + Denotes whether the value of the message parameter is a raw message or a message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST. + + + :param message_type: The message_type of this VerifyDataDetails. + :type: str + """ + allowed_values = ["RAW", "DIGEST"] + if not value_allowed_none_or_none_sentinel(message_type, allowed_values): + raise ValueError( + "Invalid value for `message_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._message_type = message_type + + @property + def message(self): + """ + **[Required]** Gets the message of this VerifyDataDetails. + The Base64-encoded binary data object denoting the message or message digest to be signed. Message can be upto 4096 size in bytes. To sign a larger message, provide the message digest. + + + :return: The message of this VerifyDataDetails. + :rtype: str + """ + return self._message + + @message.setter + def message(self, message): + """ + Sets the message of this VerifyDataDetails. + The Base64-encoded binary data object denoting the message or message digest to be signed. Message can be upto 4096 size in bytes. To sign a larger message, provide the message digest. + + + :param message: The message of this VerifyDataDetails. + :type: str + """ + self._message = message + + @property + def signing_algorithm(self): + """ + **[Required]** Gets the signing_algorithm of this VerifyDataDetails. + The algorithm to be used for signing the message or message digest + For RSA keys, there are two supported Signature Schemes: PKCS1 and PSS along with + different Hashing algorithms. + For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms. + In case of passing digest for signing, make sure the same hashing algorithm is + specified as used for created for digest. + + Allowed values for this property are: "SHA_224_RSA_PKCS_PSS", "SHA_256_RSA_PKCS_PSS", "SHA_384_RSA_PKCS_PSS", "SHA_512_RSA_PKCS_PSS", "SHA_224_RSA_PKCS1_V1_5", "SHA_256_RSA_PKCS1_V1_5", "SHA_384_RSA_PKCS1_V1_5", "SHA_512_RSA_PKCS1_V1_5", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512" + + + :return: The signing_algorithm of this VerifyDataDetails. + :rtype: str + """ + return self._signing_algorithm + + @signing_algorithm.setter + def signing_algorithm(self, signing_algorithm): + """ + Sets the signing_algorithm of this VerifyDataDetails. + The algorithm to be used for signing the message or message digest + For RSA keys, there are two supported Signature Schemes: PKCS1 and PSS along with + different Hashing algorithms. + For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms. + In case of passing digest for signing, make sure the same hashing algorithm is + specified as used for created for digest. + + + :param signing_algorithm: The signing_algorithm of this VerifyDataDetails. + :type: str + """ + allowed_values = ["SHA_224_RSA_PKCS_PSS", "SHA_256_RSA_PKCS_PSS", "SHA_384_RSA_PKCS_PSS", "SHA_512_RSA_PKCS_PSS", "SHA_224_RSA_PKCS1_V1_5", "SHA_256_RSA_PKCS1_V1_5", "SHA_384_RSA_PKCS1_V1_5", "SHA_512_RSA_PKCS1_V1_5", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512"] + if not value_allowed_none_or_none_sentinel(signing_algorithm, allowed_values): + raise ValueError( + "Invalid value for `signing_algorithm`, must be None or one of {0}" + .format(allowed_values) + ) + self._signing_algorithm = signing_algorithm + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/key_management/models/wrapped_import_key.py b/src/oci/key_management/models/wrapped_import_key.py index 72acaee732..1e887e53c0 100644 --- a/src/oci/key_management/models/wrapped_import_key.py +++ b/src/oci/key_management/models/wrapped_import_key.py @@ -17,6 +17,10 @@ class WrappedImportKey(object): #: This constant has a value of "RSA_OAEP_SHA256" WRAPPING_ALGORITHM_RSA_OAEP_SHA256 = "RSA_OAEP_SHA256" + #: A constant which can be used with the wrapping_algorithm property of a WrappedImportKey. + #: This constant has a value of "RSA_OAEP_AES_SHA256" + WRAPPING_ALGORITHM_RSA_OAEP_AES_SHA256 = "RSA_OAEP_AES_SHA256" + def __init__(self, **kwargs): """ Initializes a new WrappedImportKey object with values from keyword arguments. @@ -28,7 +32,7 @@ def __init__(self, **kwargs): :param wrapping_algorithm: The value to assign to the wrapping_algorithm property of this WrappedImportKey. - Allowed values for this property are: "RSA_OAEP_SHA256" + Allowed values for this property are: "RSA_OAEP_SHA256", "RSA_OAEP_AES_SHA256" :type wrapping_algorithm: str """ @@ -74,8 +78,12 @@ def wrapping_algorithm(self): """ **[Required]** Gets the wrapping_algorithm of this WrappedImportKey. The wrapping mechanism to use during key import. + RSA_OAEP_AES_SHA256 invokes the RSA AES key wrap mechanism, which generates a temporary AES key. The temporary AES key is wrapped + by the Vault RSA public wrapping key, creating a wrapped temporary AES key. The temporary AES key is also used to wrap the private key material. + The wrapped temporary AES key and the wrapped exportable key material are concatenated, producing concatenated blob output that jointly represents them. + RSA_OAEP_SHA256 means that the exportable key material is wrapped by the Vault RSA public wrapping key. - Allowed values for this property are: "RSA_OAEP_SHA256" + Allowed values for this property are: "RSA_OAEP_SHA256", "RSA_OAEP_AES_SHA256" :return: The wrapping_algorithm of this WrappedImportKey. @@ -88,12 +96,16 @@ def wrapping_algorithm(self, wrapping_algorithm): """ Sets the wrapping_algorithm of this WrappedImportKey. The wrapping mechanism to use during key import. + RSA_OAEP_AES_SHA256 invokes the RSA AES key wrap mechanism, which generates a temporary AES key. The temporary AES key is wrapped + by the Vault RSA public wrapping key, creating a wrapped temporary AES key. The temporary AES key is also used to wrap the private key material. + The wrapped temporary AES key and the wrapped exportable key material are concatenated, producing concatenated blob output that jointly represents them. + RSA_OAEP_SHA256 means that the exportable key material is wrapped by the Vault RSA public wrapping key. :param wrapping_algorithm: The wrapping_algorithm of this WrappedImportKey. :type: str """ - allowed_values = ["RSA_OAEP_SHA256"] + allowed_values = ["RSA_OAEP_SHA256", "RSA_OAEP_AES_SHA256"] if not value_allowed_none_or_none_sentinel(wrapping_algorithm, allowed_values): raise ValueError( "Invalid value for `wrapping_algorithm`, must be None or one of {0}" diff --git a/src/oci/resource_manager/models/__init__.py b/src/oci/resource_manager/models/__init__.py index 6141ad8b86..41d1bf3c5d 100644 --- a/src/oci/resource_manager/models/__init__.py +++ b/src/oci/resource_manager/models/__init__.py @@ -31,6 +31,7 @@ from .create_zip_upload_config_source_details import CreateZipUploadConfigSourceDetails from .destroy_job_operation_details import DestroyJobOperationDetails from .destroy_job_operation_details_summary import DestroyJobOperationDetailsSummary +from .detect_stack_drift_details import DetectStackDriftDetails from .failure_details import FailureDetails from .git_config_source import GitConfigSource from .git_config_source_record import GitConfigSourceRecord @@ -100,6 +101,7 @@ "CreateZipUploadConfigSourceDetails": CreateZipUploadConfigSourceDetails, "DestroyJobOperationDetails": DestroyJobOperationDetails, "DestroyJobOperationDetailsSummary": DestroyJobOperationDetailsSummary, + "DetectStackDriftDetails": DetectStackDriftDetails, "FailureDetails": FailureDetails, "GitConfigSource": GitConfigSource, "GitConfigSourceRecord": GitConfigSourceRecord, diff --git a/src/oci/resource_manager/models/detect_stack_drift_details.py b/src/oci/resource_manager/models/detect_stack_drift_details.py new file mode 100644 index 0000000000..ed500aed43 --- /dev/null +++ b/src/oci/resource_manager/models/detect_stack_drift_details.py @@ -0,0 +1,80 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DetectStackDriftDetails(object): + """ + The details for detecting drift in a stack + """ + + def __init__(self, **kwargs): + """ + Initializes a new DetectStackDriftDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param resource_addresses: + The value to assign to the resource_addresses property of this DetectStackDriftDetails. + :type resource_addresses: list[str] + + """ + self.swagger_types = { + 'resource_addresses': 'list[str]' + } + + self.attribute_map = { + 'resource_addresses': 'resourceAddresses' + } + + self._resource_addresses = None + + @property + def resource_addresses(self): + """ + Gets the resource_addresses of this DetectStackDriftDetails. + The list of resources in the specified stack to detect drift for. Each resource is identified by a resource address, + which is a case-insensitive string derived from the resource type and name specified in the stack's Terraform configuration plus an optional index. + For example, the resource address for the fourth Compute instance with the name \"test_instance\" is oci_core_instance.test_instance`3]. + For more details and examples of resource addresses, see the Terraform documentation at [Resource spec`__. + + __ https://www.terraform.io/docs/internals/resource-addressing.html#examples + + + :return: The resource_addresses of this DetectStackDriftDetails. + :rtype: list[str] + """ + return self._resource_addresses + + @resource_addresses.setter + def resource_addresses(self, resource_addresses): + """ + Sets the resource_addresses of this DetectStackDriftDetails. + The list of resources in the specified stack to detect drift for. Each resource is identified by a resource address, + which is a case-insensitive string derived from the resource type and name specified in the stack's Terraform configuration plus an optional index. + For example, the resource address for the fourth Compute instance with the name \"test_instance\" is oci_core_instance.test_instance`3]. + For more details and examples of resource addresses, see the Terraform documentation at [Resource spec`__. + + __ https://www.terraform.io/docs/internals/resource-addressing.html#examples + + + :param resource_addresses: The resource_addresses of this DetectStackDriftDetails. + :type: list[str] + """ + self._resource_addresses = resource_addresses + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/resource_manager/resource_manager_client.py b/src/oci/resource_manager/resource_manager_client.py index e487ccf32e..ac7efdfc55 100644 --- a/src/oci/resource_manager/resource_manager_client.py +++ b/src/oci/resource_manager/resource_manager_client.py @@ -809,6 +809,9 @@ def detect_stack_drift(self, stack_id, **kwargs): if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected. + :param oci.resource_manager.models.DetectStackDriftDetails detect_stack_drift_details: (optional) + The details for detecting drift in a stack + :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. @@ -831,7 +834,8 @@ def detect_stack_drift(self, stack_id, **kwargs): "retry_strategy", "if_match", "opc_request_id", - "opc_retry_token" + "opc_retry_token", + "detect_stack_drift_details" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -869,13 +873,15 @@ def detect_stack_drift(self, stack_id, **kwargs): resource_path=resource_path, method=method, path_params=path_params, - header_params=header_params) + header_params=header_params, + body=kwargs.get('detect_stack_drift_details')) else: return self.base_client.call_api( resource_path=resource_path, method=method, path_params=path_params, - header_params=header_params) + header_params=header_params, + body=kwargs.get('detect_stack_drift_details')) def get_configuration_source_provider(self, configuration_source_provider_id, **kwargs): """ @@ -2119,6 +2125,8 @@ def list_stack_resource_drift_details(self, stack_id, **kwargs): Lists drift status details for each resource defined in the specified stack. The drift status details for a given resource indicate differences, if any, between the actual state and the expected (defined) state for that resource. + The drift status details correspond to the specified work request (`workRequestId`). + If no work request is specified, then the drift status details correspond to the latest completed work request for the stack. :param str stack_id: (required) @@ -2130,6 +2138,11 @@ def list_stack_resource_drift_details(self, stack_id, **kwargs): Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. + :param str work_request_id: (optional) + The `OCID`__ of the work request. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + :param list[StackResourceDriftSummaryResourceDriftStatus] resource_drift_status: (optional) A filter that returns only resources that match the given drift status. The value is case-insensitive. Allowable values - @@ -2171,6 +2184,7 @@ def list_stack_resource_drift_details(self, stack_id, **kwargs): expected_kwargs = [ "retry_strategy", "opc_request_id", + "work_request_id", "resource_drift_status", "limit", "page" @@ -2191,6 +2205,7 @@ def list_stack_resource_drift_details(self, stack_id, **kwargs): raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) query_params = { + "workRequestId": kwargs.get("work_request_id", missing), "resourceDriftStatus": self.base_client.generate_collection_format_param(kwargs.get("resource_drift_status", missing), 'multi'), "limit": kwargs.get("limit", missing), "page": kwargs.get("page", missing) diff --git a/src/oci/version.py b/src/oci/version.py index 23967f39ac..5505b20826 100644 --- a/src/oci/version.py +++ b/src/oci/version.py @@ -2,4 +2,4 @@ # Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved. # This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. -__version__ = "2.28.0" +__version__ = "2.29.0"