From 934f011ef263eafa9bd4632fa961ed1d9fc99c09 Mon Sep 17 00:00:00 2001 From: Mike Ross Date: Thu, 5 Apr 2018 17:24:37 +0000 Subject: [PATCH] Releasing version 1.3.18 --- CHANGELOG.rst | 13 ++ README-development.rst | 4 +- docs/_templates/autosummary/model_class.rst | 10 ++ .../_templates/autosummary/service_client.rst | 34 ++++ .../autosummary/service_operation.rst | 5 + docs/api/audit.rst | 22 +++ docs/api/config.rst | 15 ++ docs/api/core.rst | 154 ++++++++++++++++++ docs/api/database.rst | 56 +++++++ docs/api/dns.rst | 36 ++++ docs/api/email.rst | 25 +++ docs/api/exceptions.rst | 6 + docs/api/file_storage.rst | 36 ++++ docs/api/identity.rst | 73 +++++++++ docs/api/index.rst | 139 ++++++++++++---- docs/api/landing.rst | 54 ++++++ docs/api/load_balancer.rst | 61 +++++++ docs/api/object_storage.rst | 37 +++++ docs/api/pagination.rst | 10 ++ docs/api/request_and_response.rst | 21 +++ docs/api/signing.rst | 62 +++++++ docs/api/upload_manager.rst | 9 + docs/api/utilities.rst | 9 + docs/api/waiters.rst | 7 + docs/conf.py | 10 +- docs/index.rst | 4 +- docs/installation.rst | 9 +- requirements.txt | 2 +- setup.py | 1 + src/oci/audit/audit_client.py | 12 +- src/oci/audit/models/audit_event.py | 3 + src/oci/audit/models/configuration.py | 3 + .../models/update_configuration_details.py | 3 + ...stance_principals_security_token_signer.py | 2 +- src/oci/base_client.py | 56 +++++-- src/oci/core/blockstorage_client.py | 12 +- src/oci/core/compute_client.py | 12 +- .../core/models/attach_boot_volume_details.py | 3 + .../models/attach_i_scsi_volume_details.py | 3 + .../attach_paravirtualized_volume_details.py | 3 + src/oci/core/models/attach_vnic_details.py | 3 + src/oci/core/models/attach_volume_details.py | 3 + src/oci/core/models/boot_volume.py | 35 ++++ src/oci/core/models/boot_volume_attachment.py | 19 +++ ...virtual_circuit_public_prefixes_details.py | 3 + ...virtual_circuit_public_prefixes_details.py | 3 + .../models/capture_console_history_details.py | 3 + .../connect_local_peering_gateways_details.py | 3 + ...nect_remote_peering_connections_details.py | 3 + src/oci/core/models/console_history.py | 21 +++ src/oci/core/models/cpe.py | 14 ++ src/oci/core/models/create_cpe_details.py | 3 + .../models/create_cross_connect_details.py | 3 + .../create_cross_connect_group_details.py | 3 + src/oci/core/models/create_dhcp_details.py | 3 + .../models/create_drg_attachment_details.py | 3 + src/oci/core/models/create_drg_details.py | 3 + src/oci/core/models/create_image_details.py | 15 ++ ...ate_instance_console_connection_details.py | 4 + .../models/create_internet_gateway_details.py | 3 + .../create_ip_sec_connection_details.py | 3 + .../create_local_peering_gateway_details.py | 3 + .../core/models/create_private_ip_details.py | 3 + .../core/models/create_public_ip_details.py | 11 ++ ...reate_remote_peering_connection_details.py | 3 + .../core/models/create_route_table_details.py | 3 + .../models/create_security_list_details.py | 3 + src/oci/core/models/create_subnet_details.py | 3 + src/oci/core/models/create_vcn_details.py | 3 + .../models/create_virtual_circuit_details.py | 11 ++ ...e_virtual_circuit_public_prefix_details.py | 3 + src/oci/core/models/create_vnic_details.py | 8 + .../models/create_volume_backup_details.py | 11 ++ ...volume_backup_policy_assignment_details.py | 3 + src/oci/core/models/create_volume_details.py | 3 + src/oci/core/models/cross_connect.py | 45 +++++ src/oci/core/models/cross_connect_group.py | 38 +++++ src/oci/core/models/cross_connect_location.py | 3 + src/oci/core/models/cross_connect_mapping.py | 27 +++ .../models/cross_connect_port_speed_shape.py | 3 + src/oci/core/models/cross_connect_status.py | 31 ++++ ...e_virtual_circuit_public_prefix_details.py | 3 + src/oci/core/models/dhcp_dns_option.py | 19 +++ src/oci/core/models/dhcp_option.py | 11 ++ src/oci/core/models/dhcp_options.py | 37 +++++ .../core/models/dhcp_search_domain_option.py | 6 + src/oci/core/models/drg.py | 30 ++++ src/oci/core/models/drg_attachment.py | 22 +++ src/oci/core/models/egress_security_rule.py | 3 + src/oci/core/models/export_image_details.py | 11 ++ ..._image_via_object_storage_tuple_details.py | 3 + ...rt_image_via_object_storage_uri_details.py | 3 + .../models/fast_connect_provider_service.py | 46 ++++++ .../get_public_ip_by_ip_address_details.py | 3 + .../get_public_ip_by_private_ip_id_details.py | 3 + .../core/models/i_scsi_volume_attachment.py | 3 + src/oci/core/models/icmp_options.py | 11 ++ src/oci/core/models/image.py | 47 ++++++ src/oci/core/models/image_source_details.py | 11 ++ ...source_via_object_storage_tuple_details.py | 3 + ...e_source_via_object_storage_uri_details.py | 3 + src/oci/core/models/ingress_security_rule.py | 3 + src/oci/core/models/instance.py | 57 +++++++ .../models/instance_console_connection.py | 29 ++++ src/oci/core/models/instance_credentials.py | 3 + .../core/models/instance_source_details.py | 3 + ...instance_source_via_boot_volume_details.py | 3 + .../instance_source_via_image_details.py | 3 + src/oci/core/models/internet_gateway.py | 28 ++++ src/oci/core/models/ip_sec_connection.py | 29 ++++ .../models/ip_sec_connection_device_config.py | 3 + .../models/ip_sec_connection_device_status.py | 3 + .../core/models/launch_instance_details.py | 4 + src/oci/core/models/launch_options.py | 51 ++++++ src/oci/core/models/letter_of_authority.py | 12 ++ src/oci/core/models/local_peering_gateway.py | 50 ++++++ .../paravirtualized_volume_attachment.py | 3 + .../models/peer_region_for_remote_peering.py | 5 + src/oci/core/models/port_range.py | 3 + src/oci/core/models/private_ip.py | 32 ++++ src/oci/core/models/public_ip.py | 61 +++++++ .../core/models/remote_peering_connection.py | 50 ++++++ src/oci/core/models/route_rule.py | 4 + src/oci/core/models/route_table.py | 28 ++++ src/oci/core/models/security_list.py | 34 ++++ src/oci/core/models/shape.py | 6 + src/oci/core/models/subnet.py | 31 ++++ src/oci/core/models/tcp_options.py | 4 + src/oci/core/models/tunnel_config.py | 3 + src/oci/core/models/tunnel_status.py | 15 ++ src/oci/core/models/udp_options.py | 4 + .../core/models/update_boot_volume_details.py | 3 + .../models/update_console_history_details.py | 3 + src/oci/core/models/update_cpe_details.py | 3 + .../models/update_cross_connect_details.py | 3 + .../update_cross_connect_group_details.py | 3 + src/oci/core/models/update_dhcp_details.py | 3 + .../models/update_drg_attachment_details.py | 3 + src/oci/core/models/update_drg_details.py | 3 + src/oci/core/models/update_image_details.py | 3 + .../core/models/update_instance_details.py | 3 + .../models/update_internet_gateway_details.py | 3 + .../update_ip_sec_connection_details.py | 3 + .../update_local_peering_gateway_details.py | 3 + .../core/models/update_private_ip_details.py | 3 + .../core/models/update_public_ip_details.py | 3 + ...pdate_remote_peering_connection_details.py | 3 + .../core/models/update_route_table_details.py | 3 + .../models/update_security_list_details.py | 3 + src/oci/core/models/update_subnet_details.py | 3 + src/oci/core/models/update_vcn_details.py | 3 + .../models/update_virtual_circuit_details.py | 11 ++ src/oci/core/models/update_vnic_details.py | 3 + .../models/update_volume_backup_details.py | 3 + src/oci/core/models/update_volume_details.py | 3 + src/oci/core/models/vcn.py | 27 +++ src/oci/core/models/virtual_circuit.py | 104 ++++++++++++ .../models/virtual_circuit_bandwidth_shape.py | 3 + .../models/virtual_circuit_public_prefix.py | 19 +++ src/oci/core/models/vnic.py | 37 +++++ src/oci/core/models/vnic_attachment.py | 22 +++ src/oci/core/models/volume.py | 36 ++++ src/oci/core/models/volume_attachment.py | 26 +++ src/oci/core/models/volume_backup.py | 52 ++++++ src/oci/core/models/volume_backup_policy.py | 3 + .../models/volume_backup_policy_assignment.py | 3 + src/oci/core/models/volume_backup_schedule.py | 31 ++++ src/oci/core/models/volume_source_details.py | 3 + ...olume_source_from_volume_backup_details.py | 3 + .../volume_source_from_volume_details.py | 3 + src/oci/core/virtual_network_client.py | 56 ++++++- src/oci/database/database_client.py | 12 +- src/oci/database/models/backup.py | 38 +++++ src/oci/database/models/backup_summary.py | 38 +++++ .../database/models/create_backup_details.py | 3 + .../create_data_guard_association_details.py | 34 ++++ ...sociation_to_existing_db_system_details.py | 3 + .../models/create_database_details.py | 11 ++ .../create_database_from_backup_details.py | 3 + .../database/models/create_db_home_details.py | 3 + .../create_db_home_with_db_system_id_base.py | 11 ++ ...reate_db_home_with_db_system_id_details.py | 3 + ...e_with_db_system_id_from_backup_details.py | 3 + .../database/models/data_guard_association.py | 87 ++++++++++ .../models/data_guard_association_summary.py | 87 ++++++++++ src/oci/database/models/database.py | 40 +++++ src/oci/database/models/database_summary.py | 40 +++++ src/oci/database/models/db_backup_config.py | 6 + src/oci/database/models/db_home.py | 37 +++++ src/oci/database/models/db_home_summary.py | 37 +++++ src/oci/database/models/db_node.py | 43 +++++ src/oci/database/models/db_node_summary.py | 43 +++++ src/oci/database/models/db_system.py | 79 +++++++++ .../models/db_system_shape_summary.py | 10 ++ src/oci/database/models/db_system_summary.py | 79 +++++++++ src/oci/database/models/db_version_summary.py | 7 + ...failover_data_guard_association_details.py | 3 + .../models/launch_db_system_details.py | 35 ++++ src/oci/database/models/patch.py | 41 +++++ src/oci/database/models/patch_details.py | 13 ++ .../database/models/patch_history_entry.py | 23 +++ .../models/patch_history_entry_summary.py | 23 +++ src/oci/database/models/patch_summary.py | 41 +++++ ...einstate_data_guard_association_details.py | 3 + .../models/restore_database_details.py | 3 + ...itchover_data_guard_association_details.py | 3 + .../models/update_database_details.py | 3 + .../database/models/update_db_home_details.py | 3 + .../models/update_db_system_details.py | 3 + src/oci/dns/dns_client.py | 12 +- src/oci/dns/models/create_zone_details.py | 11 ++ src/oci/dns/models/external_master.py | 3 + .../models/patch_domain_records_details.py | 3 + src/oci/dns/models/patch_rr_set_details.py | 3 + .../dns/models/patch_zone_records_details.py | 3 + src/oci/dns/models/record.py | 5 + src/oci/dns/models/record_collection.py | 3 + src/oci/dns/models/record_details.py | 5 + src/oci/dns/models/record_operation.py | 21 +++ src/oci/dns/models/rr_set.py | 6 + src/oci/dns/models/tsig.py | 5 + .../models/update_domain_records_details.py | 3 + src/oci/dns/models/update_rr_set_details.py | 3 + src/oci/dns/models/update_zone_details.py | 3 + .../dns/models/update_zone_records_details.py | 3 + src/oci/dns/models/zone.py | 31 ++++ src/oci/dns/models/zone_summary.py | 11 ++ src/oci/email/email_client.py | 12 +- src/oci/email/models/create_sender_details.py | 3 + .../models/create_suppression_details.py | 3 + src/oci/email/models/sender.py | 19 +++ src/oci/email/models/sender_summary.py | 19 +++ src/oci/email/models/suppression.py | 27 +++ src/oci/email/models/suppression_summary.py | 27 +++ src/oci/file_storage/file_storage_client.py | 13 +- .../models/create_export_details.py | 3 + .../models/create_file_system_details.py | 3 + .../models/create_mount_target_details.py | 3 + .../models/create_snapshot_details.py | 3 + src/oci/file_storage/models/export.py | 47 ++++++ src/oci/file_storage/models/export_set.py | 20 +++ .../file_storage/models/export_set_summary.py | 19 +++ src/oci/file_storage/models/export_summary.py | 19 +++ src/oci/file_storage/models/file_system.py | 30 ++++ .../models/file_system_summary.py | 19 +++ src/oci/file_storage/models/mount_target.py | 25 +++ .../models/mount_target_summary.py | 23 +++ src/oci/file_storage/models/snapshot.py | 19 +++ .../file_storage/models/snapshot_summary.py | 19 +++ .../models/update_export_set_details.py | 3 + .../models/update_file_system_details.py | 3 + .../models/update_mount_target_details.py | 3 + src/oci/identity/identity_client.py | 12 +- .../models/add_user_to_group_details.py | 3 + src/oci/identity/models/api_key.py | 35 ++++ .../identity/models/availability_domain.py | 7 + src/oci/identity/models/compartment.py | 42 +++++ .../identity/models/create_api_key_details.py | 3 + .../models/create_compartment_details.py | 3 + .../create_customer_secret_key_details.py | 3 + .../models/create_dynamic_group_details.py | 3 + .../identity/models/create_group_details.py | 3 + .../create_identity_provider_details.py | 15 ++ .../create_idp_group_mapping_details.py | 3 + .../identity/models/create_policy_details.py | 3 + .../create_region_subscription_details.py | 3 + .../create_saml2_identity_provider_details.py | 3 + .../models/create_smtp_credential_details.py | 3 + .../models/create_swift_password_details.py | 3 + src/oci/identity/models/create_tag_details.py | 3 + .../models/create_tag_namespace_details.py | 3 + .../identity/models/create_user_details.py | 3 + .../identity/models/customer_secret_key.py | 32 ++++ .../models/customer_secret_key_summary.py | 24 +++ src/oci/identity/models/dynamic_group.py | 33 ++++ src/oci/identity/models/group.py | 39 +++++ src/oci/identity/models/identity_provider.py | 34 ++++ src/oci/identity/models/idp_group_mapping.py | 35 ++++ src/oci/identity/models/policy.py | 38 +++++ src/oci/identity/models/region.py | 12 ++ .../identity/models/region_subscription.py | 19 +++ .../models/saml2_identity_provider.py | 7 + src/oci/identity/models/smtp_credential.py | 32 ++++ .../models/smtp_credential_summary.py | 27 +++ src/oci/identity/models/swift_password.py | 31 ++++ src/oci/identity/models/tag.py | 7 + src/oci/identity/models/tag_namespace.py | 6 + .../identity/models/tag_namespace_summary.py | 3 + src/oci/identity/models/tag_summary.py | 3 + src/oci/identity/models/tenancy.py | 12 ++ src/oci/identity/models/ui_password.py | 28 ++++ .../models/update_compartment_details.py | 3 + .../update_customer_secret_key_details.py | 3 + .../models/update_dynamic_group_details.py | 3 + .../identity/models/update_group_details.py | 3 + .../update_identity_provider_details.py | 7 + .../update_idp_group_mapping_details.py | 3 + .../identity/models/update_policy_details.py | 3 + .../update_saml2_identity_provider_details.py | 3 + .../models/update_smtp_credential_details.py | 3 + .../identity/models/update_state_details.py | 3 + .../models/update_swift_password_details.py | 3 + src/oci/identity/models/update_tag_details.py | 3 + .../models/update_tag_namespace_details.py | 3 + .../identity/models/update_user_details.py | 3 + src/oci/identity/models/user.py | 43 +++++ .../identity/models/user_group_membership.py | 24 +++ src/oci/load_balancer/load_balancer_client.py | 12 +- src/oci/load_balancer/models/backend.py | 6 + .../load_balancer/models/backend_details.py | 3 + .../load_balancer/models/backend_health.py | 19 +++ src/oci/load_balancer/models/backend_set.py | 7 + .../models/backend_set_details.py | 7 + .../models/backend_set_health.py | 22 +++ src/oci/load_balancer/models/certificate.py | 7 + .../models/certificate_details.py | 7 + .../models/connection_configuration.py | 3 + .../models/create_backend_details.py | 7 + .../models/create_backend_set_details.py | 7 + .../models/create_certificate_details.py | 7 + .../models/create_listener_details.py | 7 + .../models/create_load_balancer_details.py | 3 + .../models/create_path_route_set_details.py | 3 + .../models/health_check_result.py | 35 ++++ .../load_balancer/models/health_checker.py | 6 + .../models/health_checker_details.py | 3 + src/oci/load_balancer/models/ip_address.py | 3 + src/oci/load_balancer/models/listener.py | 7 + .../load_balancer/models/listener_details.py | 3 + src/oci/load_balancer/models/load_balancer.py | 37 +++++ .../models/load_balancer_health.py | 22 +++ .../models/load_balancer_health_summary.py | 19 +++ .../models/load_balancer_policy.py | 7 + .../models/load_balancer_protocol.py | 3 + .../models/load_balancer_shape.py | 7 + .../load_balancer/models/path_match_type.py | 19 +++ src/oci/load_balancer/models/path_route.py | 5 + .../load_balancer/models/path_route_set.py | 6 + .../models/path_route_set_details.py | 3 + ...ssion_persistence_configuration_details.py | 13 ++ .../load_balancer/models/ssl_configuration.py | 5 + .../models/ssl_configuration_details.py | 3 + .../models/update_backend_details.py | 3 + .../models/update_backend_set_details.py | 7 + .../models/update_health_checker_details.py | 3 + .../models/update_listener_details.py | 3 + .../models/update_load_balancer_details.py | 3 + .../models/update_path_route_set_details.py | 3 + src/oci/load_balancer/models/work_request.py | 24 +++ .../models/work_request_error.py | 11 ++ src/oci/object_storage/models/bucket.py | 32 ++++ .../object_storage/models/bucket_summary.py | 7 + .../models/commit_multipart_upload_details.py | 7 + .../commit_multipart_upload_part_details.py | 7 + .../models/create_bucket_details.py | 27 +++ .../models/create_multipart_upload_details.py | 7 + ...create_preauthenticated_request_details.py | 19 +++ src/oci/object_storage/models/list_objects.py | 7 + .../object_storage/models/multipart_upload.py | 14 ++ .../models/multipart_upload_part_summary.py | 8 + .../models/namespace_metadata.py | 3 + .../object_storage/models/object_summary.py | 7 + .../models/preauthenticated_request.py | 27 +++ .../preauthenticated_request_summary.py | 19 +++ .../models/rename_object_details.py | 7 + .../models/restore_objects_details.py | 3 + .../models/update_bucket_details.py | 19 +++ .../update_namespace_metadata_details.py | 4 + .../object_storage/object_storage_client.py | 14 +- .../object_storage/transfer/upload_manager.py | 31 +++- src/oci/version.py | 2 +- tox.ini | 2 +- 372 files changed, 5508 insertions(+), 75 deletions(-) create mode 100644 docs/_templates/autosummary/model_class.rst create mode 100644 docs/_templates/autosummary/service_client.rst create mode 100644 docs/_templates/autosummary/service_operation.rst create mode 100644 docs/api/audit.rst create mode 100644 docs/api/config.rst create mode 100644 docs/api/core.rst create mode 100644 docs/api/database.rst create mode 100644 docs/api/dns.rst create mode 100644 docs/api/email.rst create mode 100644 docs/api/exceptions.rst create mode 100644 docs/api/file_storage.rst create mode 100644 docs/api/identity.rst create mode 100644 docs/api/landing.rst create mode 100644 docs/api/load_balancer.rst create mode 100644 docs/api/object_storage.rst create mode 100644 docs/api/pagination.rst create mode 100644 docs/api/request_and_response.rst create mode 100644 docs/api/signing.rst create mode 100644 docs/api/upload_manager.rst create mode 100644 docs/api/utilities.rst create mode 100644 docs/api/waiters.rst diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 3e9517f382..00a5bd4d84 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,19 @@ All notable changes to this project will be documented in this file. The format is based on `Keep a Changelog `_. +==================== +1.3.18 - 2018-04-05 +==================== + +Added +----- +* Added Python 3.6 as a supported Python version + +Fixed +------ +* Python API reference documentation improvements + + ==================== 1.3.17 - 2018-03-26 ==================== diff --git a/README-development.rst b/README-development.rst index b521d8fe5a..81b0fc59c7 100644 --- a/README-development.rst +++ b/README-development.rst @@ -21,12 +21,12 @@ __ https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/sdkconfig.htm Running Tests ============= -The SDK uses `pytest` as its test framework. You can run tests against Python 2.7 Python 3.5 using the `tox` command. Note that this requires that you have those versions of Python installed, +The SDK uses `pytest` as its test framework. You can run tests against Python 2.7, Python 3.5 and Python 3.6 using the `tox` command. Note that this requires that you have those versions of Python installed, otherwise you must pass `-e` or run tests directly: .. code-block:: sh - # This will run tests against all configured Pythons in tox.ini (currently 2.7 and 3.5). You need to have those versions installed + # This will run tests against all configured Pythons in tox.ini (currently 2.7, 3.5 and 3.6). You need to have those versions installed tox # This will run tests against a specific Python versions diff --git a/docs/_templates/autosummary/model_class.rst b/docs/_templates/autosummary/model_class.rst new file mode 100644 index 0000000000..bfc7fb5e6a --- /dev/null +++ b/docs/_templates/autosummary/model_class.rst @@ -0,0 +1,10 @@ +{{ objname | escape | underline}} + +.. currentmodule:: {{ module }} + +.. auto{{ objtype }}:: {{ objname }} + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/_templates/autosummary/service_client.rst b/docs/_templates/autosummary/service_client.rst new file mode 100644 index 0000000000..c7e9cbaf83 --- /dev/null +++ b/docs/_templates/autosummary/service_client.rst @@ -0,0 +1,34 @@ +{{ objname | escape | underline}} + +.. currentmodule:: {{ module }} + +.. autoclass:: {{ objname }} + + {% block methods %} + .. automethod:: __init__ + + {% if methods %} + .. rubric:: Methods + + .. autosummary:: + :toctree: operations + :nosignatures: + :template: autosummary/service_operation.rst + {% for item in methods %} + {% if item != "__init__" %} + ~{{ name }}.{{ item }} + {% endif %} + {%- endfor %} + {% endif %} + {% endblock %} + + {% block attributes %} + {% if attributes %} + .. rubric:: Attributes + + .. autosummary:: + {% for item in attributes %} + ~{{ name }}.{{ item }} + {%- endfor %} + {% endif %} + {% endblock %} \ No newline at end of file diff --git a/docs/_templates/autosummary/service_operation.rst b/docs/_templates/autosummary/service_operation.rst new file mode 100644 index 0000000000..e48626618f --- /dev/null +++ b/docs/_templates/autosummary/service_operation.rst @@ -0,0 +1,5 @@ +{{ objname | escape | underline}} + +.. currentmodule:: {{ module }} + +.. auto{{ objtype }}:: {{ objname }} \ No newline at end of file diff --git a/docs/api/audit.rst b/docs/api/audit.rst new file mode 100644 index 0000000000..edaedadc97 --- /dev/null +++ b/docs/api/audit.rst @@ -0,0 +1,22 @@ +Audit +===== + +.. autosummary:: + :toctree: audit/client + :nosignatures: + :template: autosummary/service_client.rst + + oci.audit.AuditClient + +-------- + Models +-------- + +.. autosummary:: + :toctree: audit/models + :nosignatures: + :template: autosummary/model_class.rst + + oci.audit.models.AuditEvent + oci.audit.models.Configuration + oci.audit.models.UpdateConfigurationDetails diff --git a/docs/api/config.rst b/docs/api/config.rst new file mode 100644 index 0000000000..bd1eba8462 --- /dev/null +++ b/docs/api/config.rst @@ -0,0 +1,15 @@ +======== + Config +======== + +.. module:: oci.config + +.. autofunction:: from_file + +.. autofunction:: validate_config + +.. module:: oci.regions + +.. autofunction:: is_region + +.. autofunction:: endpoint_for \ No newline at end of file diff --git a/docs/api/core.rst b/docs/api/core.rst new file mode 100644 index 0000000000..399c476fbb --- /dev/null +++ b/docs/api/core.rst @@ -0,0 +1,154 @@ +Core Services +============= + +.. autosummary:: + :toctree: core/client + :nosignatures: + :template: autosummary/service_client.rst + + oci.core.BlockstorageClient + oci.core.ComputeClient + oci.core.VirtualNetworkClient + +-------- + Models +-------- + +.. autosummary:: + :toctree: core/models + :nosignatures: + :template: autosummary/model_class.rst + + oci.core.models.AttachBootVolumeDetails + oci.core.models.AttachIScsiVolumeDetails + oci.core.models.AttachParavirtualizedVolumeDetails + oci.core.models.AttachVnicDetails + oci.core.models.AttachVolumeDetails + oci.core.models.BootVolume + oci.core.models.BootVolumeAttachment + oci.core.models.BulkAddVirtualCircuitPublicPrefixesDetails + oci.core.models.BulkDeleteVirtualCircuitPublicPrefixesDetails + oci.core.models.CaptureConsoleHistoryDetails + oci.core.models.ConnectLocalPeeringGatewaysDetails + oci.core.models.ConnectRemotePeeringConnectionsDetails + oci.core.models.ConsoleHistory + oci.core.models.Cpe + oci.core.models.CreateCpeDetails + oci.core.models.CreateCrossConnectDetails + oci.core.models.CreateCrossConnectGroupDetails + oci.core.models.CreateDhcpDetails + oci.core.models.CreateDrgAttachmentDetails + oci.core.models.CreateDrgDetails + oci.core.models.CreateIPSecConnectionDetails + oci.core.models.CreateImageDetails + oci.core.models.CreateInstanceConsoleConnectionDetails + oci.core.models.CreateInternetGatewayDetails + oci.core.models.CreateLocalPeeringGatewayDetails + oci.core.models.CreatePrivateIpDetails + oci.core.models.CreatePublicIpDetails + oci.core.models.CreateRemotePeeringConnectionDetails + oci.core.models.CreateRouteTableDetails + oci.core.models.CreateSecurityListDetails + oci.core.models.CreateSubnetDetails + oci.core.models.CreateVcnDetails + oci.core.models.CreateVirtualCircuitDetails + oci.core.models.CreateVirtualCircuitPublicPrefixDetails + oci.core.models.CreateVnicDetails + oci.core.models.CreateVolumeBackupDetails + oci.core.models.CreateVolumeBackupPolicyAssignmentDetails + oci.core.models.CreateVolumeDetails + oci.core.models.CrossConnect + oci.core.models.CrossConnectGroup + oci.core.models.CrossConnectLocation + oci.core.models.CrossConnectMapping + oci.core.models.CrossConnectPortSpeedShape + oci.core.models.CrossConnectStatus + oci.core.models.DeleteVirtualCircuitPublicPrefixDetails + oci.core.models.DhcpDnsOption + oci.core.models.DhcpOption + oci.core.models.DhcpOptions + oci.core.models.DhcpSearchDomainOption + oci.core.models.Drg + oci.core.models.DrgAttachment + oci.core.models.EgressSecurityRule + oci.core.models.ExportImageDetails + oci.core.models.ExportImageViaObjectStorageTupleDetails + oci.core.models.ExportImageViaObjectStorageUriDetails + oci.core.models.FastConnectProviderService + oci.core.models.GetPublicIpByIpAddressDetails + oci.core.models.GetPublicIpByPrivateIpIdDetails + oci.core.models.IPSecConnection + oci.core.models.IPSecConnectionDeviceConfig + oci.core.models.IPSecConnectionDeviceStatus + oci.core.models.IScsiVolumeAttachment + oci.core.models.IcmpOptions + oci.core.models.Image + oci.core.models.ImageSourceDetails + oci.core.models.ImageSourceViaObjectStorageTupleDetails + oci.core.models.ImageSourceViaObjectStorageUriDetails + oci.core.models.IngressSecurityRule + oci.core.models.Instance + oci.core.models.InstanceConsoleConnection + oci.core.models.InstanceCredentials + oci.core.models.InstanceSourceDetails + oci.core.models.InstanceSourceViaBootVolumeDetails + oci.core.models.InstanceSourceViaImageDetails + oci.core.models.InternetGateway + oci.core.models.LaunchInstanceDetails + oci.core.models.LaunchOptions + oci.core.models.LetterOfAuthority + oci.core.models.LocalPeeringGateway + oci.core.models.ParavirtualizedVolumeAttachment + oci.core.models.PeerRegionForRemotePeering + oci.core.models.PortRange + oci.core.models.PrivateIp + oci.core.models.PublicIp + oci.core.models.RemotePeeringConnection + oci.core.models.RouteRule + oci.core.models.RouteTable + oci.core.models.SecurityList + oci.core.models.Shape + oci.core.models.Subnet + oci.core.models.TcpOptions + oci.core.models.TunnelConfig + oci.core.models.TunnelStatus + oci.core.models.UdpOptions + oci.core.models.UpdateBootVolumeDetails + oci.core.models.UpdateConsoleHistoryDetails + oci.core.models.UpdateCpeDetails + oci.core.models.UpdateCrossConnectDetails + oci.core.models.UpdateCrossConnectGroupDetails + oci.core.models.UpdateDhcpDetails + oci.core.models.UpdateDrgAttachmentDetails + oci.core.models.UpdateDrgDetails + oci.core.models.UpdateIPSecConnectionDetails + oci.core.models.UpdateImageDetails + oci.core.models.UpdateInstanceDetails + oci.core.models.UpdateInternetGatewayDetails + oci.core.models.UpdateLocalPeeringGatewayDetails + oci.core.models.UpdatePrivateIpDetails + oci.core.models.UpdatePublicIpDetails + oci.core.models.UpdateRemotePeeringConnectionDetails + oci.core.models.UpdateRouteTableDetails + oci.core.models.UpdateSecurityListDetails + oci.core.models.UpdateSubnetDetails + oci.core.models.UpdateVcnDetails + oci.core.models.UpdateVirtualCircuitDetails + oci.core.models.UpdateVnicDetails + oci.core.models.UpdateVolumeBackupDetails + oci.core.models.UpdateVolumeDetails + oci.core.models.Vcn + oci.core.models.VirtualCircuit + oci.core.models.VirtualCircuitBandwidthShape + oci.core.models.VirtualCircuitPublicPrefix + oci.core.models.Vnic + oci.core.models.VnicAttachment + oci.core.models.Volume + oci.core.models.VolumeAttachment + oci.core.models.VolumeBackup + oci.core.models.VolumeBackupPolicy + oci.core.models.VolumeBackupPolicyAssignment + oci.core.models.VolumeBackupSchedule + oci.core.models.VolumeSourceDetails + oci.core.models.VolumeSourceFromVolumeBackupDetails + oci.core.models.VolumeSourceFromVolumeDetails diff --git a/docs/api/database.rst b/docs/api/database.rst new file mode 100644 index 0000000000..fca74c3fbf --- /dev/null +++ b/docs/api/database.rst @@ -0,0 +1,56 @@ +Database +======== + +.. autosummary:: + :toctree: database/client + :nosignatures: + :template: autosummary/service_client.rst + + oci.database.DatabaseClient + +-------- + Models +-------- + +.. autosummary:: + :toctree: database/models + :nosignatures: + :template: autosummary/model_class.rst + + oci.database.models.Backup + oci.database.models.BackupSummary + oci.database.models.CreateBackupDetails + oci.database.models.CreateDataGuardAssociationDetails + oci.database.models.CreateDataGuardAssociationToExistingDbSystemDetails + oci.database.models.CreateDatabaseDetails + oci.database.models.CreateDatabaseFromBackupDetails + oci.database.models.CreateDbHomeDetails + oci.database.models.CreateDbHomeWithDbSystemIdBase + oci.database.models.CreateDbHomeWithDbSystemIdDetails + oci.database.models.CreateDbHomeWithDbSystemIdFromBackupDetails + oci.database.models.DataGuardAssociation + oci.database.models.DataGuardAssociationSummary + oci.database.models.Database + oci.database.models.DatabaseSummary + oci.database.models.DbBackupConfig + oci.database.models.DbHome + oci.database.models.DbHomeSummary + oci.database.models.DbNode + oci.database.models.DbNodeSummary + oci.database.models.DbSystem + oci.database.models.DbSystemShapeSummary + oci.database.models.DbSystemSummary + oci.database.models.DbVersionSummary + oci.database.models.FailoverDataGuardAssociationDetails + oci.database.models.LaunchDbSystemDetails + oci.database.models.Patch + oci.database.models.PatchDetails + oci.database.models.PatchHistoryEntry + oci.database.models.PatchHistoryEntrySummary + oci.database.models.PatchSummary + oci.database.models.ReinstateDataGuardAssociationDetails + oci.database.models.RestoreDatabaseDetails + oci.database.models.SwitchoverDataGuardAssociationDetails + oci.database.models.UpdateDatabaseDetails + oci.database.models.UpdateDbHomeDetails + oci.database.models.UpdateDbSystemDetails diff --git a/docs/api/dns.rst b/docs/api/dns.rst new file mode 100644 index 0000000000..952b4a5922 --- /dev/null +++ b/docs/api/dns.rst @@ -0,0 +1,36 @@ +DNS +=== + +.. autosummary:: + :toctree: dns/client + :nosignatures: + :template: autosummary/service_client.rst + + oci.dns.DnsClient + +-------- + Models +-------- + +.. autosummary:: + :toctree: dns/models + :nosignatures: + :template: autosummary/model_class.rst + + oci.dns.models.CreateZoneDetails + oci.dns.models.ExternalMaster + oci.dns.models.PatchDomainRecordsDetails + oci.dns.models.PatchRRSetDetails + oci.dns.models.PatchZoneRecordsDetails + oci.dns.models.RRSet + oci.dns.models.Record + oci.dns.models.RecordCollection + oci.dns.models.RecordDetails + oci.dns.models.RecordOperation + oci.dns.models.TSIG + oci.dns.models.UpdateDomainRecordsDetails + oci.dns.models.UpdateRRSetDetails + oci.dns.models.UpdateZoneDetails + oci.dns.models.UpdateZoneRecordsDetails + oci.dns.models.Zone + oci.dns.models.ZoneSummary diff --git a/docs/api/email.rst b/docs/api/email.rst new file mode 100644 index 0000000000..a1246aa695 --- /dev/null +++ b/docs/api/email.rst @@ -0,0 +1,25 @@ +Email +===== + +.. autosummary:: + :toctree: email/client + :nosignatures: + :template: autosummary/service_client.rst + + oci.email.EmailClient + +-------- + Models +-------- + +.. autosummary:: + :toctree: email/models + :nosignatures: + :template: autosummary/model_class.rst + + oci.email.models.CreateSenderDetails + oci.email.models.CreateSuppressionDetails + oci.email.models.Sender + oci.email.models.SenderSummary + oci.email.models.Suppression + oci.email.models.SuppressionSummary diff --git a/docs/api/exceptions.rst b/docs/api/exceptions.rst new file mode 100644 index 0000000000..890e64e00a --- /dev/null +++ b/docs/api/exceptions.rst @@ -0,0 +1,6 @@ +============ + Exceptions +============ + +.. automodule:: oci.exceptions + :members: \ No newline at end of file diff --git a/docs/api/file_storage.rst b/docs/api/file_storage.rst new file mode 100644 index 0000000000..e22f72f9f7 --- /dev/null +++ b/docs/api/file_storage.rst @@ -0,0 +1,36 @@ +File Storage +============ + +.. autosummary:: + :toctree: file_storage/client + :nosignatures: + :template: autosummary/service_client.rst + + oci.file_storage.FileStorageClient + +-------- + Models +-------- + +.. autosummary:: + :toctree: file_storage/models + :nosignatures: + :template: autosummary/model_class.rst + + oci.file_storage.models.CreateExportDetails + oci.file_storage.models.CreateFileSystemDetails + oci.file_storage.models.CreateMountTargetDetails + oci.file_storage.models.CreateSnapshotDetails + oci.file_storage.models.Export + oci.file_storage.models.ExportSet + oci.file_storage.models.ExportSetSummary + oci.file_storage.models.ExportSummary + oci.file_storage.models.FileSystem + oci.file_storage.models.FileSystemSummary + oci.file_storage.models.MountTarget + oci.file_storage.models.MountTargetSummary + oci.file_storage.models.Snapshot + oci.file_storage.models.SnapshotSummary + oci.file_storage.models.UpdateExportSetDetails + oci.file_storage.models.UpdateFileSystemDetails + oci.file_storage.models.UpdateMountTargetDetails diff --git a/docs/api/identity.rst b/docs/api/identity.rst new file mode 100644 index 0000000000..0ed1b34a2d --- /dev/null +++ b/docs/api/identity.rst @@ -0,0 +1,73 @@ +Identity +======== + +.. autosummary:: + :toctree: identity/client + :nosignatures: + :template: autosummary/service_client.rst + + oci.identity.IdentityClient + +-------- + Models +-------- + +.. autosummary:: + :toctree: identity/models + :nosignatures: + :template: autosummary/model_class.rst + + oci.identity.models.AddUserToGroupDetails + oci.identity.models.ApiKey + oci.identity.models.AvailabilityDomain + oci.identity.models.Compartment + oci.identity.models.CreateApiKeyDetails + oci.identity.models.CreateCompartmentDetails + oci.identity.models.CreateCustomerSecretKeyDetails + oci.identity.models.CreateDynamicGroupDetails + oci.identity.models.CreateGroupDetails + oci.identity.models.CreateIdentityProviderDetails + oci.identity.models.CreateIdpGroupMappingDetails + oci.identity.models.CreatePolicyDetails + oci.identity.models.CreateRegionSubscriptionDetails + oci.identity.models.CreateSaml2IdentityProviderDetails + oci.identity.models.CreateSmtpCredentialDetails + oci.identity.models.CreateSwiftPasswordDetails + oci.identity.models.CreateTagDetails + oci.identity.models.CreateTagNamespaceDetails + oci.identity.models.CreateUserDetails + oci.identity.models.CustomerSecretKey + oci.identity.models.CustomerSecretKeySummary + oci.identity.models.DynamicGroup + oci.identity.models.Group + oci.identity.models.IdentityProvider + oci.identity.models.IdpGroupMapping + oci.identity.models.Policy + oci.identity.models.Region + oci.identity.models.RegionSubscription + oci.identity.models.Saml2IdentityProvider + oci.identity.models.SmtpCredential + oci.identity.models.SmtpCredentialSummary + oci.identity.models.SwiftPassword + oci.identity.models.Tag + oci.identity.models.TagNamespace + oci.identity.models.TagNamespaceSummary + oci.identity.models.TagSummary + oci.identity.models.Tenancy + oci.identity.models.UIPassword + oci.identity.models.UpdateCompartmentDetails + oci.identity.models.UpdateCustomerSecretKeyDetails + oci.identity.models.UpdateDynamicGroupDetails + oci.identity.models.UpdateGroupDetails + oci.identity.models.UpdateIdentityProviderDetails + oci.identity.models.UpdateIdpGroupMappingDetails + oci.identity.models.UpdatePolicyDetails + oci.identity.models.UpdateSaml2IdentityProviderDetails + oci.identity.models.UpdateSmtpCredentialDetails + oci.identity.models.UpdateStateDetails + oci.identity.models.UpdateSwiftPasswordDetails + oci.identity.models.UpdateTagDetails + oci.identity.models.UpdateTagNamespaceDetails + oci.identity.models.UpdateUserDetails + oci.identity.models.User + oci.identity.models.UserGroupMembership diff --git a/docs/api/index.rst b/docs/api/index.rst index 6f9169839d..70f1d57768 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -9,12 +9,13 @@ } -API Reference -~~~~~~~~~~~~~ +Single Page Reference +~~~~~~~~~~~~~~~~~~~~~~ -======= - Audit -======= + +===== +Audit +===== -------- Client @@ -22,6 +23,7 @@ API Reference .. autoclass:: oci.audit.audit_client.AuditClient :members: + :noindex: -------- Models @@ -33,10 +35,12 @@ API Reference :undoc-members: :imported-members: :inherited-members: + :noindex: -=============== - Core Services -=============== + +============= +Core Services +============= --------- Clients @@ -48,19 +52,24 @@ Block Storage .. autoclass:: oci.core.blockstorage_client.BlockstorageClient :members: + :noindex: -Compute -======= + +Compute +======== .. autoclass:: oci.core.compute_client.ComputeClient :members: + :noindex: -Virtual Network -=============== +Virtual Network +================ .. autoclass:: oci.core.virtual_network_client.VirtualNetworkClient :members: + :noindex: + -------- Models @@ -72,10 +81,12 @@ Virtual Network :undoc-members: :imported-members: :inherited-members: + :noindex: + -========== - Database -========== +======== +Database +======== -------- Client @@ -83,6 +94,7 @@ Virtual Network .. autoclass:: oci.database.database_client.DatabaseClient :members: + :noindex: -------- Models @@ -94,10 +106,12 @@ Virtual Network :undoc-members: :imported-members: :inherited-members: + :noindex: + -========== - DNS -========== +=== +DNS +=== -------- Client @@ -105,6 +119,7 @@ Virtual Network .. autoclass:: oci.dns.dns_client.DnsClient :members: + :noindex: -------- Models @@ -116,10 +131,12 @@ Virtual Network :undoc-members: :imported-members: :inherited-members: + :noindex: -========== - Email -========== + +===== +Email +===== -------- Client @@ -127,6 +144,7 @@ Virtual Network .. autoclass:: oci.email.email_client.EmailClient :members: + :noindex: -------- Models @@ -138,10 +156,12 @@ Virtual Network :undoc-members: :imported-members: :inherited-members: + :noindex: -============== - File Storage -============== + +============ +File Storage +============ -------- Client @@ -149,6 +169,7 @@ Virtual Network .. autoclass:: oci.file_storage.file_storage_client.FileStorageClient :members: + :noindex: -------- Models @@ -160,10 +181,12 @@ Virtual Network :undoc-members: :imported-members: :inherited-members: + :noindex: -========== - Identity -========== + +======== +Identity +======== -------- Client @@ -171,6 +194,7 @@ Virtual Network .. autoclass:: oci.identity.identity_client.IdentityClient :members: + :noindex: -------- Models @@ -182,10 +206,12 @@ Virtual Network :undoc-members: :imported-members: :inherited-members: + :noindex: -============== + +============= Load Balancer -============== +============= -------- Client @@ -193,6 +219,7 @@ Load Balancer .. autoclass:: oci.load_balancer.load_balancer_client.LoadBalancerClient :members: + :noindex: -------- Models @@ -204,10 +231,12 @@ Load Balancer :undoc-members: :imported-members: :inherited-members: + :noindex: -================ - Object Storage -================ + +============== +Object Storage +============== -------- Client @@ -215,6 +244,7 @@ Load Balancer .. autoclass:: oci.object_storage.object_storage_client.ObjectStorageClient :members: + :noindex: -------- Models @@ -226,16 +256,20 @@ Load Balancer :undoc-members: :imported-members: :inherited-members: + :noindex: + ================ Upload Manager ================ .. module:: oci.object_storage + :noindex: .. autoclass:: UploadManager :special-members: __init__ :members: + :noindex: ============= Base Client @@ -251,16 +285,22 @@ Load Balancer ======== .. module:: oci.config + :noindex: .. autofunction:: from_file + :noindex: .. autofunction:: validate_config + :noindex: .. module:: oci.regions + :noindex: .. autofunction:: is_region + :noindex: .. autofunction:: endpoint_for + :noindex: ============ @@ -269,115 +309,148 @@ Load Balancer .. automodule:: oci.exceptions :members: + :noindex: ========= Signing ========= .. module:: oci.signer + :noindex: .. autofunction:: load_private_key_from_file + :noindex: .. autofunction:: load_private_key + :noindex: .. autoclass:: Signer + :noindex: ===================== Additional Signers ===================== .. module:: oci.auth.signers + :noindex: .. autoclass:: SecurityTokenSigner :special-members: __init__ :members: + :noindex: .. autoclass:: X509FederationClientBasedSecurityTokenSigner :special-members: __init__ :members: + :noindex: .. autoclass:: InstancePrincipalsSecurityTokenSigner :special-members: __init__ :members: + :noindex: ============================ X509 Certificate Retrievers ============================ .. module:: oci.auth.certificate_retriever + :noindex: .. autoclass:: UrlBasedCertificateRetriever :special-members: __init__ :members: + :noindex: .. autoclass:: PEMStringCertificateRetriever :special-members: __init__ :members: + :noindex: .. autoclass:: FileBasedCertificateRetriever :special-members: __init__ :members: + :noindex: ==================================== X509 Certificate Federation Client ==================================== .. module:: oci.auth.federation_client + :noindex: .. autoclass:: X509FederationClient :special-members: __init__ :members: + :noindex: .. module:: oci.auth.session_key_supplier + :noindex: .. autoclass:: SessionKeySupplier :special-members: __init__ :members: + :noindex: =========== Utilities =========== .. module:: oci.util + :noindex: .. autofunction:: to_dict + :noindex: .. autoclass:: Sentinel + :noindex: =========== Waiters =========== .. module:: oci + :noindex: .. autofunction:: wait_until + :noindex: =========== Pagination =========== .. module:: oci.pagination + :noindex: .. autofunction:: list_call_get_all_results + :noindex: + .. autofunction:: list_call_get_up_to_limit + :noindex: + .. autofunction:: list_call_get_all_results_generator + :noindex: + .. autofunction:: list_call_get_up_to_limit_generator + :noindex: ========= Request ========= .. module:: oci.request + :noindex: .. autoclass:: Request :members: :undoc-members: + :noindex: ========= Response ========= .. module:: oci.response + :noindex: .. autoclass:: Response :members: :undoc-members: - + :noindex: \ No newline at end of file diff --git a/docs/api/landing.rst b/docs/api/landing.rst new file mode 100644 index 0000000000..3b01ad1aeb --- /dev/null +++ b/docs/api/landing.rst @@ -0,0 +1,54 @@ +API Reference +~~~~~~~~~~~~~~~~ + +.. rubric:: Service Clients + +* :doc:`Audit ` +* :doc:`Block Storage ` +* :doc:`Compute ` +* :doc:`Virtual Network ` +* :doc:`Database ` +* :doc:`DNS ` +* :doc:`Email ` +* :doc:`File Storage ` +* :doc:`Identity ` +* :doc:`Load Balancer ` +* :doc:`Object Storage ` + +.. rubric:: Other Modules + +* :doc:`Config ` +* :doc:`Exceptions ` +* :doc:`Pagination ` +* :doc:`Request and Response ` +* :doc:`Signing ` +* :doc:`Upload Manager ` +* :doc:`Utilities ` +* :doc:`Waiters ` + +.. rubric:: Single Page Reference + +* :doc:`Single Page Reference ` + +.. toctree:: + :hidden: + :maxdepth: 5 + + audit + core + database + dns + email + file_storage + identity + load_balancer + object_storage + config + exceptions + pagination + request_and_response + signing + upload_manager + utilities + waiters + index \ No newline at end of file diff --git a/docs/api/load_balancer.rst b/docs/api/load_balancer.rst new file mode 100644 index 0000000000..74a53e1b60 --- /dev/null +++ b/docs/api/load_balancer.rst @@ -0,0 +1,61 @@ +Load Balancer +============= + +.. autosummary:: + :toctree: load_balancer/client + :nosignatures: + :template: autosummary/service_client.rst + + oci.load_balancer.LoadBalancerClient + +-------- + Models +-------- + +.. autosummary:: + :toctree: load_balancer/models + :nosignatures: + :template: autosummary/model_class.rst + + oci.load_balancer.models.Backend + oci.load_balancer.models.BackendDetails + oci.load_balancer.models.BackendHealth + oci.load_balancer.models.BackendSet + oci.load_balancer.models.BackendSetDetails + oci.load_balancer.models.BackendSetHealth + oci.load_balancer.models.Certificate + oci.load_balancer.models.CertificateDetails + oci.load_balancer.models.ConnectionConfiguration + oci.load_balancer.models.CreateBackendDetails + oci.load_balancer.models.CreateBackendSetDetails + oci.load_balancer.models.CreateCertificateDetails + oci.load_balancer.models.CreateListenerDetails + oci.load_balancer.models.CreateLoadBalancerDetails + oci.load_balancer.models.CreatePathRouteSetDetails + oci.load_balancer.models.HealthCheckResult + oci.load_balancer.models.HealthChecker + oci.load_balancer.models.HealthCheckerDetails + oci.load_balancer.models.IpAddress + oci.load_balancer.models.Listener + oci.load_balancer.models.ListenerDetails + oci.load_balancer.models.LoadBalancer + oci.load_balancer.models.LoadBalancerHealth + oci.load_balancer.models.LoadBalancerHealthSummary + oci.load_balancer.models.LoadBalancerPolicy + oci.load_balancer.models.LoadBalancerProtocol + oci.load_balancer.models.LoadBalancerShape + oci.load_balancer.models.PathMatchType + oci.load_balancer.models.PathRoute + oci.load_balancer.models.PathRouteSet + oci.load_balancer.models.PathRouteSetDetails + oci.load_balancer.models.SSLConfiguration + oci.load_balancer.models.SSLConfigurationDetails + oci.load_balancer.models.SessionPersistenceConfigurationDetails + oci.load_balancer.models.UpdateBackendDetails + oci.load_balancer.models.UpdateBackendSetDetails + oci.load_balancer.models.UpdateHealthCheckerDetails + oci.load_balancer.models.UpdateListenerDetails + oci.load_balancer.models.UpdateLoadBalancerDetails + oci.load_balancer.models.UpdatePathRouteSetDetails + oci.load_balancer.models.WorkRequest + oci.load_balancer.models.WorkRequestError diff --git a/docs/api/object_storage.rst b/docs/api/object_storage.rst new file mode 100644 index 0000000000..0312b72dde --- /dev/null +++ b/docs/api/object_storage.rst @@ -0,0 +1,37 @@ +Object Storage +============== + +.. autosummary:: + :toctree: object_storage/client + :nosignatures: + :template: autosummary/service_client.rst + + oci.object_storage.ObjectStorageClient + +-------- + Models +-------- + +.. autosummary:: + :toctree: object_storage/models + :nosignatures: + :template: autosummary/model_class.rst + + oci.object_storage.models.Bucket + oci.object_storage.models.BucketSummary + oci.object_storage.models.CommitMultipartUploadDetails + oci.object_storage.models.CommitMultipartUploadPartDetails + oci.object_storage.models.CreateBucketDetails + oci.object_storage.models.CreateMultipartUploadDetails + oci.object_storage.models.CreatePreauthenticatedRequestDetails + oci.object_storage.models.ListObjects + oci.object_storage.models.MultipartUpload + oci.object_storage.models.MultipartUploadPartSummary + oci.object_storage.models.NamespaceMetadata + oci.object_storage.models.ObjectSummary + oci.object_storage.models.PreauthenticatedRequest + oci.object_storage.models.PreauthenticatedRequestSummary + oci.object_storage.models.RenameObjectDetails + oci.object_storage.models.RestoreObjectsDetails + oci.object_storage.models.UpdateBucketDetails + oci.object_storage.models.UpdateNamespaceMetadataDetails diff --git a/docs/api/pagination.rst b/docs/api/pagination.rst new file mode 100644 index 0000000000..cdb4531ecb --- /dev/null +++ b/docs/api/pagination.rst @@ -0,0 +1,10 @@ +=========== + Pagination +=========== + +.. module:: oci.pagination + +.. autofunction:: list_call_get_all_results +.. autofunction:: list_call_get_up_to_limit +.. autofunction:: list_call_get_all_results_generator +.. autofunction:: list_call_get_up_to_limit_generator \ No newline at end of file diff --git a/docs/api/request_and_response.rst b/docs/api/request_and_response.rst new file mode 100644 index 0000000000..def584f2cb --- /dev/null +++ b/docs/api/request_and_response.rst @@ -0,0 +1,21 @@ +Request and Response +~~~~~~~~~~~~~~~~~~~~~ + + +========= +Request +========= +.. module:: oci.request + +.. autoclass:: Request + :members: + :undoc-members: + +========= +Response +========= +.. module:: oci.response + +.. autoclass:: Response + :members: + :undoc-members: \ No newline at end of file diff --git a/docs/api/signing.rst b/docs/api/signing.rst new file mode 100644 index 0000000000..0da13635e9 --- /dev/null +++ b/docs/api/signing.rst @@ -0,0 +1,62 @@ +Signing +~~~~~~~~ + +.. module:: oci.signer + +.. autofunction:: load_private_key_from_file + +.. autofunction:: load_private_key + +.. autoclass:: Signer + +===================== + Additional Signers +===================== + +.. module:: oci.auth.signers + +.. autoclass:: SecurityTokenSigner + :special-members: __init__ + :members: + +.. autoclass:: X509FederationClientBasedSecurityTokenSigner + :special-members: __init__ + :members: + +.. autoclass:: InstancePrincipalsSecurityTokenSigner + :special-members: __init__ + :members: + +============================ +X509 Certificate Retrievers +============================ + +.. module:: oci.auth.certificate_retriever + +.. autoclass:: UrlBasedCertificateRetriever + :special-members: __init__ + :members: + +.. autoclass:: PEMStringCertificateRetriever + :special-members: __init__ + :members: + +.. autoclass:: FileBasedCertificateRetriever + :special-members: __init__ + :members: + +==================================== +X509 Certificate Federation Client +==================================== + +.. module:: oci.auth.federation_client + +.. autoclass:: X509FederationClient + :special-members: __init__ + :members: + +.. module:: oci.auth.session_key_supplier + +.. autoclass:: SessionKeySupplier + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/upload_manager.rst b/docs/api/upload_manager.rst new file mode 100644 index 0000000000..f41fa1284a --- /dev/null +++ b/docs/api/upload_manager.rst @@ -0,0 +1,9 @@ +================ + Upload Manager +================ + +.. module:: oci.object_storage + +.. autoclass:: UploadManager + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/utilities.rst b/docs/api/utilities.rst new file mode 100644 index 0000000000..53348f266c --- /dev/null +++ b/docs/api/utilities.rst @@ -0,0 +1,9 @@ +=========== + Utilities +=========== + +.. module:: oci.util + +.. autofunction:: to_dict + +.. autoclass:: Sentinel diff --git a/docs/api/waiters.rst b/docs/api/waiters.rst new file mode 100644 index 0000000000..909d73cba7 --- /dev/null +++ b/docs/api/waiters.rst @@ -0,0 +1,7 @@ +=========== + Waiters +=========== + +.. module:: oci + +.. autofunction:: wait_until \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index f6c6893b4a..5d854d1b27 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -12,11 +12,15 @@ # ones. extensions = [ "sphinx.ext.autodoc", + "sphinx.ext.autosummary", "sphinx.ext.intersphinx", ] +# Automatically generate stub pages for the .. autosummary:: directive when combined with :toctree: +autosummary_generate = True + # Add any paths that contain templates here, relative to this directory. -# templates_path = ['_templates'] +templates_path = ['_templates'] # The master toctree document. master_doc = "index" @@ -242,8 +246,8 @@ class PatchedPythonDomain(PythonDomain): def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode): - if 'refspecific' in node and fromdocname == 'api/index': - # This for api/index.rst and defined tags. These have a data type of dict(str, dict(str, object)) but if + if 'refspecific' in node and fromdocname.startswith('api/'): + # This for api/* and defined tags. These have a data type of dict(str, dict(str, object)) but if # Sphinx auto-linking tries to link "object" to the "object" property in CreateMultipartUploadDetails (which is # incorrect). # diff --git a/docs/index.rst b/docs/index.rst index 99358b9ab1..2c27aad12b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -40,7 +40,7 @@ To get started, head over to the :ref:`installation instructions ` or s .. toctree:: :hidden: - :maxdepth: 2 + :maxdepth: 5 installation configuration @@ -53,7 +53,7 @@ To get started, head over to the :ref:`installation instructions ` or s raw-requests waiters pagination - api/index + api/landing customize_service_client/index sdk_behaviors/index contributions diff --git a/docs/installation.rst b/docs/installation.rst index 5ac7ff3b0f..4f138d09c2 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -15,10 +15,17 @@ Installation This topic describes how to install, configure, and use the Oracle Cloud Infrastructure Python SDK. The Python SDK supports operations for the following services: -* Identity and Access Management Service +* Audit Service * Core Services (Networking Service, Compute Service, and Block Volume Service) +* Database Service +* DNS Service +* Email Service +* File Storage Service +* Identity and Access Management Service +* Load Balancing Service * Object Storage Service + =============== Prerequisites =============== diff --git a/requirements.txt b/requirements.txt index 8ff456ab79..8cecb6db27 100755 --- a/requirements.txt +++ b/requirements.txt @@ -12,7 +12,7 @@ pytest-catchlog==1.2.2 python-dateutil==2.5.3 pytz==2016.10 requests==2.18.4 -sphinx-rtd-theme==0.1.9 +sphinx-rtd-theme==0.2.5b2 six==1.11.0 sphinx==1.6.4 tox==2.9.1 diff --git a/setup.py b/setup.py index 05371202cf..fd3cdcb0d2 100644 --- a/setup.py +++ b/setup.py @@ -61,5 +61,6 @@ def open_relative(*path): "License :: OSI Approved :: Universal Permissive License (UPL)", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.5", + "Programming Language :: Python :: 3.6", ] ) diff --git a/src/oci/audit/audit_client.py b/src/oci/audit/audit_client.py index ced314fc95..7542b04996 100644 --- a/src/oci/audit/audit_client.py +++ b/src/oci/audit/audit_client.py @@ -16,6 +16,9 @@ class AuditClient(object): + """ + API for the Audit Service. You can use this API for queries, but not bulk-export operations. + """ def __init__(self, config, **kwargs): validate_config(config, signer=kwargs.get('signer')) @@ -30,7 +33,14 @@ def __init__(self, config, **kwargs): pass_phrase=get_config_value_or_default(config, "pass_phrase"), private_key_content=config.get("key_content") ) - self.base_client = BaseClient("audit", config, signer, audit_type_mapping) + + base_client_init_kwargs = { + 'regional_client': True, + 'service_endpoint': kwargs.get('service_endpoint'), + 'timeout': kwargs.get('timeout'), + 'base_path': '/20160918' + } + self.base_client = BaseClient("audit", config, signer, audit_type_mapping, **base_client_init_kwargs) self.retry_strategy = kwargs.get('retry_strategy') def get_configuration(self, compartment_id, **kwargs): diff --git a/src/oci/audit/models/audit_event.py b/src/oci/audit/models/audit_event.py index de27dc918f..27e3038388 100644 --- a/src/oci/audit/models/audit_event.py +++ b/src/oci/audit/models/audit_event.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class AuditEvent(object): + """ + AuditEvent model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/audit/models/configuration.py b/src/oci/audit/models/configuration.py index 1678504aae..8f668fe8b6 100644 --- a/src/oci/audit/models/configuration.py +++ b/src/oci/audit/models/configuration.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class Configuration(object): + """ + Configuration model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/audit/models/update_configuration_details.py b/src/oci/audit/models/update_configuration_details.py index b98c1c4ec3..ee4ee1b04e 100644 --- a/src/oci/audit/models/update_configuration_details.py +++ b/src/oci/audit/models/update_configuration_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateConfigurationDetails(object): + """ + UpdateConfigurationDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/auth/signers/instance_principals_security_token_signer.py b/src/oci/auth/signers/instance_principals_security_token_signer.py index 468456ea1d..2a1dbd4b35 100644 --- a/src/oci/auth/signers/instance_principals_security_token_signer.py +++ b/src/oci/auth/signers/instance_principals_security_token_signer.py @@ -76,7 +76,7 @@ def initialize_and_return_region(self): return self.region response = requests.get(self.GET_REGION_URL) - region_raw = response.text.strip() + region_raw = response.text.strip().lower() # The region can be something like "phx" but internally we expect "us-phoenix-1", "us-ashburn-1" etc. if region_raw in oci.regions.REGIONS_SHORT_NAMES: diff --git a/src/oci/base_client.py b/src/oci/base_client.py index 654a6badbc..b950c9e0c2 100644 --- a/src/oci/base_client.py +++ b/src/oci/base_client.py @@ -83,15 +83,32 @@ def __init__(self, service, config, signer, type_mapping, **kwargs): validate_config(config, signer=signer) self.signer = signer - region_to_use = None - if 'region' in config and config['region']: - region_to_use = config.get('region') - elif hasattr(signer, 'region'): - region_to_use = signer.region - self.endpoint = regions.endpoint_for( - service, - region=region_to_use, - endpoint=config.get("endpoint")) + # Default to true (is a regional client) if there is nothing explicitly set. Regional + # clients allow us to call set_region and that'll also set the endpoint. For non-regional + # clients we require an endpoint + self.regional_client = kwargs.get('regional_client', True) + + self._endpoint = None + self._base_path = kwargs.get('base_path') + + if self.regional_client: + if kwargs.get('service_endpoint'): + self.endpoint = kwargs.get('service_endpoint') + else: + region_to_use = None + if 'region' in config and config['region']: + region_to_use = config.get('region') + elif hasattr(signer, 'region'): + region_to_use = signer.region + + self.endpoint = regions.endpoint_for( + service, + region=region_to_use, + endpoint=config.get('endpoint')) + else: + if not kwargs.get('service_endpoint'): + raise ValueError('An endpoint must be provided for a non-regional service client') + self.endpoint = kwargs.get('service_endpoint') self.service = service self.complex_type_mappings = type_mapping @@ -108,8 +125,27 @@ def __init__(self, service, config, signer, type_mapping, **kwargs): else: six.moves.http_client.HTTPConnection.debuglevel = 0 + @property + def endpoint(self): + return self._endpoint + + @endpoint.setter + def endpoint(self, endpoint): + if self._base_path == '/': + # If it's just the root path then use the endpoint as-is + self._endpoint = endpoint + elif self._base_path and not (endpoint.endswith(self._base_path) or endpoint.endswith('{}/'.format(self._base_path))): + # Account for formats like https://iaas.us-phoenix-1.oraclecloud.com/20160918 and + # https://iaas.us-phoenix-1.oraclecloud.com/20160918/ as they should both be fine + self._endpoint = '{}{}'.format(endpoint, self._base_path) + else: + self._endpoint = endpoint + def set_region(self, region): - self.endpoint = regions.endpoint_for(self.service, region=region) + if self.regional_client: + self.endpoint = regions.endpoint_for(self.service, region=region) + else: + raise TypeError('Setting the region is not allowed for non-regional service clients. You must instead set the endpoint') def call_api(self, resource_path, method, path_params=None, diff --git a/src/oci/core/blockstorage_client.py b/src/oci/core/blockstorage_client.py index 11b65167cc..19b791c136 100644 --- a/src/oci/core/blockstorage_client.py +++ b/src/oci/core/blockstorage_client.py @@ -16,6 +16,9 @@ class BlockstorageClient(object): + """ + APIs for Networking Service, Compute Service, and Block Volume Service. + """ def __init__(self, config, **kwargs): validate_config(config, signer=kwargs.get('signer')) @@ -30,7 +33,14 @@ def __init__(self, config, **kwargs): pass_phrase=get_config_value_or_default(config, "pass_phrase"), private_key_content=config.get("key_content") ) - self.base_client = BaseClient("blockstorage", config, signer, core_type_mapping) + + base_client_init_kwargs = { + 'regional_client': True, + 'service_endpoint': kwargs.get('service_endpoint'), + 'timeout': kwargs.get('timeout'), + 'base_path': '/20160918' + } + self.base_client = BaseClient("blockstorage", config, signer, core_type_mapping, **base_client_init_kwargs) self.retry_strategy = kwargs.get('retry_strategy') def create_volume(self, create_volume_details, **kwargs): diff --git a/src/oci/core/compute_client.py b/src/oci/core/compute_client.py index 911ca7f62a..90bba1dae1 100644 --- a/src/oci/core/compute_client.py +++ b/src/oci/core/compute_client.py @@ -16,6 +16,9 @@ class ComputeClient(object): + """ + APIs for Networking Service, Compute Service, and Block Volume Service. + """ def __init__(self, config, **kwargs): validate_config(config, signer=kwargs.get('signer')) @@ -30,7 +33,14 @@ def __init__(self, config, **kwargs): pass_phrase=get_config_value_or_default(config, "pass_phrase"), private_key_content=config.get("key_content") ) - self.base_client = BaseClient("compute", config, signer, core_type_mapping) + + base_client_init_kwargs = { + 'regional_client': True, + 'service_endpoint': kwargs.get('service_endpoint'), + 'timeout': kwargs.get('timeout'), + 'base_path': '/20160918' + } + self.base_client = BaseClient("compute", config, signer, core_type_mapping, **base_client_init_kwargs) self.retry_strategy = kwargs.get('retry_strategy') def attach_boot_volume(self, attach_boot_volume_details, **kwargs): diff --git a/src/oci/core/models/attach_boot_volume_details.py b/src/oci/core/models/attach_boot_volume_details.py index a646e00b99..7f25820697 100644 --- a/src/oci/core/models/attach_boot_volume_details.py +++ b/src/oci/core/models/attach_boot_volume_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class AttachBootVolumeDetails(object): + """ + AttachBootVolumeDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/attach_i_scsi_volume_details.py b/src/oci/core/models/attach_i_scsi_volume_details.py index 34f0736cb3..a52199bfe0 100644 --- a/src/oci/core/models/attach_i_scsi_volume_details.py +++ b/src/oci/core/models/attach_i_scsi_volume_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class AttachIScsiVolumeDetails(AttachVolumeDetails): + """ + AttachIScsiVolumeDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/attach_paravirtualized_volume_details.py b/src/oci/core/models/attach_paravirtualized_volume_details.py index b7c0cf7fc1..f58e81b34f 100644 --- a/src/oci/core/models/attach_paravirtualized_volume_details.py +++ b/src/oci/core/models/attach_paravirtualized_volume_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class AttachParavirtualizedVolumeDetails(AttachVolumeDetails): + """ + AttachParavirtualizedVolumeDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/attach_vnic_details.py b/src/oci/core/models/attach_vnic_details.py index 671812b009..8591458b68 100644 --- a/src/oci/core/models/attach_vnic_details.py +++ b/src/oci/core/models/attach_vnic_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class AttachVnicDetails(object): + """ + AttachVnicDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/attach_volume_details.py b/src/oci/core/models/attach_volume_details.py index 18061855a6..b2d2f2f412 100644 --- a/src/oci/core/models/attach_volume_details.py +++ b/src/oci/core/models/attach_volume_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class AttachVolumeDetails(object): + """ + AttachVolumeDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/boot_volume.py b/src/oci/core/models/boot_volume.py index cfea68ac75..ba391b0323 100644 --- a/src/oci/core/models/boot_volume.py +++ b/src/oci/core/models/boot_volume.py @@ -8,6 +8,41 @@ @init_model_state_from_kwargs class BootVolume(object): + """ + A detachable boot volume device that contains the image used to boot an Compute instance. For more information, see + `Overview of Boot Volumes`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/bootvolumes.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a BootVolume. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a BootVolume. + #: This constant has a value of "RESTORING" + LIFECYCLE_STATE_RESTORING = "RESTORING" + + #: A constant which can be used with the lifecycle_state property of a BootVolume. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a BootVolume. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a BootVolume. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" + + #: A constant which can be used with the lifecycle_state property of a BootVolume. + #: This constant has a value of "FAULTY" + LIFECYCLE_STATE_FAULTY = "FAULTY" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/boot_volume_attachment.py b/src/oci/core/models/boot_volume_attachment.py index ce3ae2a746..16154bb9fd 100644 --- a/src/oci/core/models/boot_volume_attachment.py +++ b/src/oci/core/models/boot_volume_attachment.py @@ -8,6 +8,25 @@ @init_model_state_from_kwargs class BootVolumeAttachment(object): + """ + Represents an attachment between a boot volume and an instance. + """ + + #: A constant which can be used with the lifecycle_state property of a BootVolumeAttachment. + #: This constant has a value of "ATTACHING" + LIFECYCLE_STATE_ATTACHING = "ATTACHING" + + #: A constant which can be used with the lifecycle_state property of a BootVolumeAttachment. + #: This constant has a value of "ATTACHED" + LIFECYCLE_STATE_ATTACHED = "ATTACHED" + + #: A constant which can be used with the lifecycle_state property of a BootVolumeAttachment. + #: This constant has a value of "DETACHING" + LIFECYCLE_STATE_DETACHING = "DETACHING" + + #: A constant which can be used with the lifecycle_state property of a BootVolumeAttachment. + #: This constant has a value of "DETACHED" + LIFECYCLE_STATE_DETACHED = "DETACHED" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/bulk_add_virtual_circuit_public_prefixes_details.py b/src/oci/core/models/bulk_add_virtual_circuit_public_prefixes_details.py index 0b0c23782c..6b43168b66 100644 --- a/src/oci/core/models/bulk_add_virtual_circuit_public_prefixes_details.py +++ b/src/oci/core/models/bulk_add_virtual_circuit_public_prefixes_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class BulkAddVirtualCircuitPublicPrefixesDetails(object): + """ + BulkAddVirtualCircuitPublicPrefixesDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/bulk_delete_virtual_circuit_public_prefixes_details.py b/src/oci/core/models/bulk_delete_virtual_circuit_public_prefixes_details.py index 9d2979fc65..39990746c2 100644 --- a/src/oci/core/models/bulk_delete_virtual_circuit_public_prefixes_details.py +++ b/src/oci/core/models/bulk_delete_virtual_circuit_public_prefixes_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class BulkDeleteVirtualCircuitPublicPrefixesDetails(object): + """ + BulkDeleteVirtualCircuitPublicPrefixesDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/capture_console_history_details.py b/src/oci/core/models/capture_console_history_details.py index 9cc417a669..9d2fb424b1 100644 --- a/src/oci/core/models/capture_console_history_details.py +++ b/src/oci/core/models/capture_console_history_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CaptureConsoleHistoryDetails(object): + """ + CaptureConsoleHistoryDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/connect_local_peering_gateways_details.py b/src/oci/core/models/connect_local_peering_gateways_details.py index 741d98dc32..c77fca9ed6 100644 --- a/src/oci/core/models/connect_local_peering_gateways_details.py +++ b/src/oci/core/models/connect_local_peering_gateways_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class ConnectLocalPeeringGatewaysDetails(object): + """ + Information about the other local peering gateway (LPG). + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/connect_remote_peering_connections_details.py b/src/oci/core/models/connect_remote_peering_connections_details.py index 0f5ae3a324..bbb05e0596 100644 --- a/src/oci/core/models/connect_remote_peering_connections_details.py +++ b/src/oci/core/models/connect_remote_peering_connections_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class ConnectRemotePeeringConnectionsDetails(object): + """ + Information about the other remote peering connection (RPC). + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/console_history.py b/src/oci/core/models/console_history.py index 333143da6d..e714a9a434 100644 --- a/src/oci/core/models/console_history.py +++ b/src/oci/core/models/console_history.py @@ -8,6 +8,27 @@ @init_model_state_from_kwargs class ConsoleHistory(object): + """ + An instance's serial console data. It includes configuration messages that occur when the + instance boots, such as kernel and BIOS messages, and is useful for checking the status of + the instance or diagnosing problems. The console data is minimally formatted ASCII text. + """ + + #: A constant which can be used with the lifecycle_state property of a ConsoleHistory. + #: This constant has a value of "REQUESTED" + LIFECYCLE_STATE_REQUESTED = "REQUESTED" + + #: A constant which can be used with the lifecycle_state property of a ConsoleHistory. + #: This constant has a value of "GETTING-HISTORY" + LIFECYCLE_STATE_GETTING_HISTORY = "GETTING-HISTORY" + + #: A constant which can be used with the lifecycle_state property of a ConsoleHistory. + #: This constant has a value of "SUCCEEDED" + LIFECYCLE_STATE_SUCCEEDED = "SUCCEEDED" + + #: A constant which can be used with the lifecycle_state property of a ConsoleHistory. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/cpe.py b/src/oci/core/models/cpe.py index 6fec196a86..36277bd35b 100644 --- a/src/oci/core/models/cpe.py +++ b/src/oci/core/models/cpe.py @@ -8,6 +8,20 @@ @init_model_state_from_kwargs class Cpe(object): + """ + An object you create when setting up an IPSec VPN between your on-premises network + and VCN. The `Cpe` is a virtual representation of your Customer-Premises Equipment, + which is the actual router on-premises at your site at your end of the IPSec VPN connection. + For more information, + see `Overview of the Networking Service`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/create_cpe_details.py b/src/oci/core/models/create_cpe_details.py index 41709e8d87..089b406b64 100644 --- a/src/oci/core/models/create_cpe_details.py +++ b/src/oci/core/models/create_cpe_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateCpeDetails(object): + """ + CreateCpeDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/create_cross_connect_details.py b/src/oci/core/models/create_cross_connect_details.py index 63f40f7791..453a9de0eb 100644 --- a/src/oci/core/models/create_cross_connect_details.py +++ b/src/oci/core/models/create_cross_connect_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateCrossConnectDetails(object): + """ + CreateCrossConnectDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/create_cross_connect_group_details.py b/src/oci/core/models/create_cross_connect_group_details.py index e9cca2bc8b..966287073a 100644 --- a/src/oci/core/models/create_cross_connect_group_details.py +++ b/src/oci/core/models/create_cross_connect_group_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateCrossConnectGroupDetails(object): + """ + CreateCrossConnectGroupDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/create_dhcp_details.py b/src/oci/core/models/create_dhcp_details.py index d218a2b613..e859eadad0 100644 --- a/src/oci/core/models/create_dhcp_details.py +++ b/src/oci/core/models/create_dhcp_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateDhcpDetails(object): + """ + CreateDhcpDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/create_drg_attachment_details.py b/src/oci/core/models/create_drg_attachment_details.py index 7a10405e4d..867b41fc2c 100644 --- a/src/oci/core/models/create_drg_attachment_details.py +++ b/src/oci/core/models/create_drg_attachment_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateDrgAttachmentDetails(object): + """ + CreateDrgAttachmentDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/create_drg_details.py b/src/oci/core/models/create_drg_details.py index 659f1053a3..e268fbb82c 100644 --- a/src/oci/core/models/create_drg_details.py +++ b/src/oci/core/models/create_drg_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateDrgDetails(object): + """ + CreateDrgDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/create_image_details.py b/src/oci/core/models/create_image_details.py index e31c13cf73..08adf53dae 100644 --- a/src/oci/core/models/create_image_details.py +++ b/src/oci/core/models/create_image_details.py @@ -8,6 +8,21 @@ @init_model_state_from_kwargs class CreateImageDetails(object): + """ + Either instanceId or imageSourceDetails must be provided in addition to other required parameters. + """ + + #: A constant which can be used with the launch_mode property of a CreateImageDetails. + #: This constant has a value of "NATIVE" + LAUNCH_MODE_NATIVE = "NATIVE" + + #: A constant which can be used with the launch_mode property of a CreateImageDetails. + #: This constant has a value of "EMULATED" + LAUNCH_MODE_EMULATED = "EMULATED" + + #: A constant which can be used with the launch_mode property of a CreateImageDetails. + #: This constant has a value of "CUSTOM" + LAUNCH_MODE_CUSTOM = "CUSTOM" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/create_instance_console_connection_details.py b/src/oci/core/models/create_instance_console_connection_details.py index 8bead22151..8a1180ea0e 100644 --- a/src/oci/core/models/create_instance_console_connection_details.py +++ b/src/oci/core/models/create_instance_console_connection_details.py @@ -8,6 +8,10 @@ @init_model_state_from_kwargs class CreateInstanceConsoleConnectionDetails(object): + """ + The details for creating a instance console connection. + The instance console connection is created in the same compartment as the instance. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/create_internet_gateway_details.py b/src/oci/core/models/create_internet_gateway_details.py index 0f08f3a190..4050e361f9 100644 --- a/src/oci/core/models/create_internet_gateway_details.py +++ b/src/oci/core/models/create_internet_gateway_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateInternetGatewayDetails(object): + """ + CreateInternetGatewayDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/create_ip_sec_connection_details.py b/src/oci/core/models/create_ip_sec_connection_details.py index 455999c4cb..d7fac358be 100644 --- a/src/oci/core/models/create_ip_sec_connection_details.py +++ b/src/oci/core/models/create_ip_sec_connection_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateIPSecConnectionDetails(object): + """ + CreateIPSecConnectionDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/create_local_peering_gateway_details.py b/src/oci/core/models/create_local_peering_gateway_details.py index d81779e1d1..57c42613be 100644 --- a/src/oci/core/models/create_local_peering_gateway_details.py +++ b/src/oci/core/models/create_local_peering_gateway_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateLocalPeeringGatewayDetails(object): + """ + CreateLocalPeeringGatewayDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/create_private_ip_details.py b/src/oci/core/models/create_private_ip_details.py index c0f09bf7cd..de1feb576b 100644 --- a/src/oci/core/models/create_private_ip_details.py +++ b/src/oci/core/models/create_private_ip_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreatePrivateIpDetails(object): + """ + CreatePrivateIpDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/create_public_ip_details.py b/src/oci/core/models/create_public_ip_details.py index 498e2be792..6bbd2c325f 100644 --- a/src/oci/core/models/create_public_ip_details.py +++ b/src/oci/core/models/create_public_ip_details.py @@ -8,6 +8,17 @@ @init_model_state_from_kwargs class CreatePublicIpDetails(object): + """ + CreatePublicIpDetails model. + """ + + #: A constant which can be used with the lifetime property of a CreatePublicIpDetails. + #: This constant has a value of "EPHEMERAL" + LIFETIME_EPHEMERAL = "EPHEMERAL" + + #: A constant which can be used with the lifetime property of a CreatePublicIpDetails. + #: This constant has a value of "RESERVED" + LIFETIME_RESERVED = "RESERVED" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/create_remote_peering_connection_details.py b/src/oci/core/models/create_remote_peering_connection_details.py index 574986d471..52796fb5ac 100644 --- a/src/oci/core/models/create_remote_peering_connection_details.py +++ b/src/oci/core/models/create_remote_peering_connection_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateRemotePeeringConnectionDetails(object): + """ + CreateRemotePeeringConnectionDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/create_route_table_details.py b/src/oci/core/models/create_route_table_details.py index 0d34fd9bfc..6c9c2e5edf 100644 --- a/src/oci/core/models/create_route_table_details.py +++ b/src/oci/core/models/create_route_table_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateRouteTableDetails(object): + """ + CreateRouteTableDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/create_security_list_details.py b/src/oci/core/models/create_security_list_details.py index afd58c43fd..b187a13ac5 100644 --- a/src/oci/core/models/create_security_list_details.py +++ b/src/oci/core/models/create_security_list_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateSecurityListDetails(object): + """ + CreateSecurityListDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/create_subnet_details.py b/src/oci/core/models/create_subnet_details.py index 47fede1698..2715a0d1a2 100644 --- a/src/oci/core/models/create_subnet_details.py +++ b/src/oci/core/models/create_subnet_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateSubnetDetails(object): + """ + CreateSubnetDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/create_vcn_details.py b/src/oci/core/models/create_vcn_details.py index 524cb92f2b..a87a60c7a2 100644 --- a/src/oci/core/models/create_vcn_details.py +++ b/src/oci/core/models/create_vcn_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateVcnDetails(object): + """ + CreateVcnDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/create_virtual_circuit_details.py b/src/oci/core/models/create_virtual_circuit_details.py index 999ef53b58..fddc367ef2 100644 --- a/src/oci/core/models/create_virtual_circuit_details.py +++ b/src/oci/core/models/create_virtual_circuit_details.py @@ -8,6 +8,17 @@ @init_model_state_from_kwargs class CreateVirtualCircuitDetails(object): + """ + CreateVirtualCircuitDetails model. + """ + + #: A constant which can be used with the type property of a CreateVirtualCircuitDetails. + #: This constant has a value of "PUBLIC" + TYPE_PUBLIC = "PUBLIC" + + #: A constant which can be used with the type property of a CreateVirtualCircuitDetails. + #: This constant has a value of "PRIVATE" + TYPE_PRIVATE = "PRIVATE" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/create_virtual_circuit_public_prefix_details.py b/src/oci/core/models/create_virtual_circuit_public_prefix_details.py index 75e49a5fa1..44e362210a 100644 --- a/src/oci/core/models/create_virtual_circuit_public_prefix_details.py +++ b/src/oci/core/models/create_virtual_circuit_public_prefix_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateVirtualCircuitPublicPrefixDetails(object): + """ + CreateVirtualCircuitPublicPrefixDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/create_vnic_details.py b/src/oci/core/models/create_vnic_details.py index f65b730ed5..e272a38689 100644 --- a/src/oci/core/models/create_vnic_details.py +++ b/src/oci/core/models/create_vnic_details.py @@ -8,6 +8,14 @@ @init_model_state_from_kwargs class CreateVnicDetails(object): + """ + Contains properties for a VNIC. You use this object when creating the + primary VNIC during instance launch or when creating a secondary VNIC. + For more information about VNICs, see + `Virtual Network Interface Cards (VNICs)`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVNICs.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/create_volume_backup_details.py b/src/oci/core/models/create_volume_backup_details.py index 587f1ad846..d83ea2ac31 100644 --- a/src/oci/core/models/create_volume_backup_details.py +++ b/src/oci/core/models/create_volume_backup_details.py @@ -8,6 +8,17 @@ @init_model_state_from_kwargs class CreateVolumeBackupDetails(object): + """ + CreateVolumeBackupDetails model. + """ + + #: A constant which can be used with the type property of a CreateVolumeBackupDetails. + #: This constant has a value of "FULL" + TYPE_FULL = "FULL" + + #: A constant which can be used with the type property of a CreateVolumeBackupDetails. + #: This constant has a value of "INCREMENTAL" + TYPE_INCREMENTAL = "INCREMENTAL" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/create_volume_backup_policy_assignment_details.py b/src/oci/core/models/create_volume_backup_policy_assignment_details.py index 886b4a4703..5f5c593d3b 100644 --- a/src/oci/core/models/create_volume_backup_policy_assignment_details.py +++ b/src/oci/core/models/create_volume_backup_policy_assignment_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateVolumeBackupPolicyAssignmentDetails(object): + """ + CreateVolumeBackupPolicyAssignmentDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/create_volume_details.py b/src/oci/core/models/create_volume_details.py index 39aff096f0..73a4dc932e 100644 --- a/src/oci/core/models/create_volume_details.py +++ b/src/oci/core/models/create_volume_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateVolumeDetails(object): + """ + CreateVolumeDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/cross_connect.py b/src/oci/core/models/cross_connect.py index 67c67d2b90..42d715d559 100644 --- a/src/oci/core/models/cross_connect.py +++ b/src/oci/core/models/cross_connect.py @@ -8,6 +8,51 @@ @init_model_state_from_kwargs class CrossConnect(object): + """ + For use with Oracle Cloud Infrastructure FastConnect. A cross-connect represents a + physical connection between an existing network and Oracle. Customers who are colocated + with Oracle in a FastConnect location create and use cross-connects. For more + information, see `FastConnect Overview`__. + + Oracle recommends you create each cross-connect in a + :class:`CrossConnectGroup` so you can use link aggregation + with the connection. + + **Note:** If you're a provider who is setting up a physical connection to Oracle so customers + can use FastConnect over the connection, be aware that your connection is modeled the + same way as a colocated customer's (with `CrossConnect` and `CrossConnectGroup` objects, and so on). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a CrossConnect. + #: This constant has a value of "PENDING_CUSTOMER" + LIFECYCLE_STATE_PENDING_CUSTOMER = "PENDING_CUSTOMER" + + #: A constant which can be used with the lifecycle_state property of a CrossConnect. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a CrossConnect. + #: This constant has a value of "PROVISIONED" + LIFECYCLE_STATE_PROVISIONED = "PROVISIONED" + + #: A constant which can be used with the lifecycle_state property of a CrossConnect. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the lifecycle_state property of a CrossConnect. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a CrossConnect. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/cross_connect_group.py b/src/oci/core/models/cross_connect_group.py index 9f6b071a1d..29db9041ae 100644 --- a/src/oci/core/models/cross_connect_group.py +++ b/src/oci/core/models/cross_connect_group.py @@ -8,6 +8,44 @@ @init_model_state_from_kwargs class CrossConnectGroup(object): + """ + For use with Oracle Cloud Infrastructure FastConnect. A cross-connect group + is a link aggregation group (LAG), which can contain one or more + :class:`CrossConnect`. Customers who are colocated with + Oracle in a FastConnect location create and use cross-connect groups. For more + information, see `FastConnect Overview`__. + + **Note:** If you're a provider who is setting up a physical connection to Oracle so customers + can use FastConnect over the connection, be aware that your connection is modeled the + same way as a colocated customer's (with `CrossConnect` and `CrossConnectGroup` objects, and so on). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a CrossConnectGroup. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a CrossConnectGroup. + #: This constant has a value of "PROVISIONED" + LIFECYCLE_STATE_PROVISIONED = "PROVISIONED" + + #: A constant which can be used with the lifecycle_state property of a CrossConnectGroup. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the lifecycle_state property of a CrossConnectGroup. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a CrossConnectGroup. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/cross_connect_location.py b/src/oci/core/models/cross_connect_location.py index 16e45cd43f..4d8b443b8b 100644 --- a/src/oci/core/models/cross_connect_location.py +++ b/src/oci/core/models/cross_connect_location.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CrossConnectLocation(object): + """ + An individual FastConnect location. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/cross_connect_mapping.py b/src/oci/core/models/cross_connect_mapping.py index 79ef0db033..46318e5943 100644 --- a/src/oci/core/models/cross_connect_mapping.py +++ b/src/oci/core/models/cross_connect_mapping.py @@ -8,6 +8,33 @@ @init_model_state_from_kwargs class CrossConnectMapping(object): + """ + For use with Oracle Cloud Infrastructure FastConnect. Each + :class:`VirtualCircuit` runs on one or + more cross-connects or cross-connect groups. A `CrossConnectMapping` + contains the properties for an individual cross-connect or cross-connect group + associated with a given virtual circuit. + + The mapping includes information about the cross-connect or + cross-connect group, the VLAN, and the BGP peering session. + + If you're a customer who is colocated with Oracle, that means you own both + the virtual circuit and the physical connection it runs on (cross-connect or + cross-connect group), so you specify all the information in the mapping. There's + one exception: for a public virtual circuit, Oracle specifies the BGP IP + addresses. + + If you're a provider, then you own the physical connection that the customer's + virtual circuit runs on, so you contribute information about the cross-connect + or cross-connect group and VLAN. + + Who specifies the BGP peering information in the case of customer connection via + provider? If the BGP session goes from Oracle to the provider's edge router, then + the provider also specifies the BGP peering information. If the BGP session instead + goes from Oracle to the customer's edge router, then the customer specifies the BGP + peering information. There's one exception: for a public virtual circuit, Oracle + specifies the BGP IP addresses. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/cross_connect_port_speed_shape.py b/src/oci/core/models/cross_connect_port_speed_shape.py index fce783e5b7..32a96d3bff 100644 --- a/src/oci/core/models/cross_connect_port_speed_shape.py +++ b/src/oci/core/models/cross_connect_port_speed_shape.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CrossConnectPortSpeedShape(object): + """ + An individual port speed level for cross-connects. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/cross_connect_status.py b/src/oci/core/models/cross_connect_status.py index 87212625f1..953e8b14a1 100644 --- a/src/oci/core/models/cross_connect_status.py +++ b/src/oci/core/models/cross_connect_status.py @@ -8,6 +8,37 @@ @init_model_state_from_kwargs class CrossConnectStatus(object): + """ + The status of the cross-connect. + """ + + #: A constant which can be used with the interface_state property of a CrossConnectStatus. + #: This constant has a value of "UP" + INTERFACE_STATE_UP = "UP" + + #: A constant which can be used with the interface_state property of a CrossConnectStatus. + #: This constant has a value of "DOWN" + INTERFACE_STATE_DOWN = "DOWN" + + #: A constant which can be used with the light_level_indicator property of a CrossConnectStatus. + #: This constant has a value of "NO_LIGHT" + LIGHT_LEVEL_INDICATOR_NO_LIGHT = "NO_LIGHT" + + #: A constant which can be used with the light_level_indicator property of a CrossConnectStatus. + #: This constant has a value of "LOW_WARN" + LIGHT_LEVEL_INDICATOR_LOW_WARN = "LOW_WARN" + + #: A constant which can be used with the light_level_indicator property of a CrossConnectStatus. + #: This constant has a value of "HIGH_WARN" + LIGHT_LEVEL_INDICATOR_HIGH_WARN = "HIGH_WARN" + + #: A constant which can be used with the light_level_indicator property of a CrossConnectStatus. + #: This constant has a value of "BAD" + LIGHT_LEVEL_INDICATOR_BAD = "BAD" + + #: A constant which can be used with the light_level_indicator property of a CrossConnectStatus. + #: This constant has a value of "GOOD" + LIGHT_LEVEL_INDICATOR_GOOD = "GOOD" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/delete_virtual_circuit_public_prefix_details.py b/src/oci/core/models/delete_virtual_circuit_public_prefix_details.py index e9dcf998b5..74c5c1a8f9 100644 --- a/src/oci/core/models/delete_virtual_circuit_public_prefix_details.py +++ b/src/oci/core/models/delete_virtual_circuit_public_prefix_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class DeleteVirtualCircuitPublicPrefixDetails(object): + """ + DeleteVirtualCircuitPublicPrefixDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/dhcp_dns_option.py b/src/oci/core/models/dhcp_dns_option.py index 515bd8cb67..ed252dd05c 100644 --- a/src/oci/core/models/dhcp_dns_option.py +++ b/src/oci/core/models/dhcp_dns_option.py @@ -8,6 +8,25 @@ @init_model_state_from_kwargs class DhcpDnsOption(DhcpOption): + """ + DHCP option for specifying how DNS (hostname resolution) is handled in the subnets in the VCN. + For more information, see + `DNS in Your Virtual Cloud Network`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm + """ + + #: A constant which can be used with the server_type property of a DhcpDnsOption. + #: This constant has a value of "VcnLocal" + SERVER_TYPE_VCN_LOCAL = "VcnLocal" + + #: A constant which can be used with the server_type property of a DhcpDnsOption. + #: This constant has a value of "VcnLocalPlusInternet" + SERVER_TYPE_VCN_LOCAL_PLUS_INTERNET = "VcnLocalPlusInternet" + + #: A constant which can be used with the server_type property of a DhcpDnsOption. + #: This constant has a value of "CustomDnsServer" + SERVER_TYPE_CUSTOM_DNS_SERVER = "CustomDnsServer" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/dhcp_option.py b/src/oci/core/models/dhcp_option.py index bccb7033cd..a3835b4d3f 100644 --- a/src/oci/core/models/dhcp_option.py +++ b/src/oci/core/models/dhcp_option.py @@ -8,6 +8,17 @@ @init_model_state_from_kwargs class DhcpOption(object): + """ + A single DHCP option according to `RFC 1533`__. + The two options available to use are :class:`DhcpDnsOption` + and :class:`DhcpSearchDomainOption`. For more + information, see `DNS in Your Virtual Cloud Network`__ + and `DHCP Options`__. + + __ https://tools.ietf.org/html/rfc1533 + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingDHCP.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/dhcp_options.py b/src/oci/core/models/dhcp_options.py index 9443d4d568..b225cb6d3d 100644 --- a/src/oci/core/models/dhcp_options.py +++ b/src/oci/core/models/dhcp_options.py @@ -8,6 +8,43 @@ @init_model_state_from_kwargs class DhcpOptions(object): + """ + A set of DHCP options. Used by the VCN to automatically provide configuration + information to the instances when they boot up. There are two options you can set: + + - :class:`DhcpDnsOption`: Lets you specify how DNS (hostname resolution) is + handled in the subnets in your VCN. + + - :class:`DhcpSearchDomainOption`: Lets you specify + a search domain name to use for DNS queries. + + For more information, see `DNS in Your Virtual Cloud Network`__ + and `DHCP Options`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingDHCP.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a DhcpOptions. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a DhcpOptions. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a DhcpOptions. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a DhcpOptions. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/dhcp_search_domain_option.py b/src/oci/core/models/dhcp_search_domain_option.py index 631ac47b6f..5b96e641dc 100644 --- a/src/oci/core/models/dhcp_search_domain_option.py +++ b/src/oci/core/models/dhcp_search_domain_option.py @@ -8,6 +8,12 @@ @init_model_state_from_kwargs class DhcpSearchDomainOption(DhcpOption): + """ + DHCP option for specifying a search domain name for DNS queries. For more information, see + `DNS in Your Virtual Cloud Network`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/drg.py b/src/oci/core/models/drg.py index 25a89f804c..f952c331ab 100644 --- a/src/oci/core/models/drg.py +++ b/src/oci/core/models/drg.py @@ -8,6 +8,36 @@ @init_model_state_from_kwargs class Drg(object): + """ + A Dynamic Routing Gateway (DRG), which is a virtual router that provides a path for private + network traffic between your VCN and your existing network. You use it with other Networking + Service components to create an IPSec VPN or a connection that uses + Oracle Cloud Infrastructure FastConnect. For more information, see + `Overview of the Networking Service`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a Drg. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a Drg. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a Drg. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a Drg. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/drg_attachment.py b/src/oci/core/models/drg_attachment.py index d704abf9f8..c73c10d403 100644 --- a/src/oci/core/models/drg_attachment.py +++ b/src/oci/core/models/drg_attachment.py @@ -8,6 +8,28 @@ @init_model_state_from_kwargs class DrgAttachment(object): + """ + A link between a DRG and VCN. For more information, see + `Overview of the Networking Service`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm + """ + + #: A constant which can be used with the lifecycle_state property of a DrgAttachment. + #: This constant has a value of "ATTACHING" + LIFECYCLE_STATE_ATTACHING = "ATTACHING" + + #: A constant which can be used with the lifecycle_state property of a DrgAttachment. + #: This constant has a value of "ATTACHED" + LIFECYCLE_STATE_ATTACHED = "ATTACHED" + + #: A constant which can be used with the lifecycle_state property of a DrgAttachment. + #: This constant has a value of "DETACHING" + LIFECYCLE_STATE_DETACHING = "DETACHING" + + #: A constant which can be used with the lifecycle_state property of a DrgAttachment. + #: This constant has a value of "DETACHED" + LIFECYCLE_STATE_DETACHED = "DETACHED" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/egress_security_rule.py b/src/oci/core/models/egress_security_rule.py index 0098fa49af..bbb871c65b 100644 --- a/src/oci/core/models/egress_security_rule.py +++ b/src/oci/core/models/egress_security_rule.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class EgressSecurityRule(object): + """ + A rule for allowing outbound IP packets. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/export_image_details.py b/src/oci/core/models/export_image_details.py index d59eacb913..f167755cd4 100644 --- a/src/oci/core/models/export_image_details.py +++ b/src/oci/core/models/export_image_details.py @@ -8,6 +8,17 @@ @init_model_state_from_kwargs class ExportImageDetails(object): + """ + The destination details for the image export. + + Set `destinationType` to `objectStorageTuple` + and use :func:`export_image_via_object_storage_tuple_details` + when specifying the namespace, bucket name, and object name. + + Set `destinationType` to `objectStorageUri` and + use :func:`export_image_via_object_storage_uri_details` + when specifying the Object Storage URL. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/export_image_via_object_storage_tuple_details.py b/src/oci/core/models/export_image_via_object_storage_tuple_details.py index 19b9148f16..a5f5bc30df 100644 --- a/src/oci/core/models/export_image_via_object_storage_tuple_details.py +++ b/src/oci/core/models/export_image_via_object_storage_tuple_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class ExportImageViaObjectStorageTupleDetails(ExportImageDetails): + """ + ExportImageViaObjectStorageTupleDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/export_image_via_object_storage_uri_details.py b/src/oci/core/models/export_image_via_object_storage_uri_details.py index 8e45191d9c..f639d06202 100644 --- a/src/oci/core/models/export_image_via_object_storage_uri_details.py +++ b/src/oci/core/models/export_image_via_object_storage_uri_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class ExportImageViaObjectStorageUriDetails(ExportImageDetails): + """ + ExportImageViaObjectStorageUriDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/fast_connect_provider_service.py b/src/oci/core/models/fast_connect_provider_service.py index bfceca7672..ec1b72a7db 100644 --- a/src/oci/core/models/fast_connect_provider_service.py +++ b/src/oci/core/models/fast_connect_provider_service.py @@ -8,6 +8,52 @@ @init_model_state_from_kwargs class FastConnectProviderService(object): + """ + A service offering from a supported provider. For more information, + see `FastConnect Overview`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm + """ + + #: A constant which can be used with the private_peering_bgp_management property of a FastConnectProviderService. + #: This constant has a value of "CUSTOMER_MANAGED" + PRIVATE_PEERING_BGP_MANAGEMENT_CUSTOMER_MANAGED = "CUSTOMER_MANAGED" + + #: A constant which can be used with the private_peering_bgp_management property of a FastConnectProviderService. + #: This constant has a value of "PROVIDER_MANAGED" + PRIVATE_PEERING_BGP_MANAGEMENT_PROVIDER_MANAGED = "PROVIDER_MANAGED" + + #: A constant which can be used with the private_peering_bgp_management property of a FastConnectProviderService. + #: This constant has a value of "ORACLE_MANAGED" + PRIVATE_PEERING_BGP_MANAGEMENT_ORACLE_MANAGED = "ORACLE_MANAGED" + + #: A constant which can be used with the public_peering_bgp_management property of a FastConnectProviderService. + #: This constant has a value of "CUSTOMER_MANAGED" + PUBLIC_PEERING_BGP_MANAGEMENT_CUSTOMER_MANAGED = "CUSTOMER_MANAGED" + + #: A constant which can be used with the public_peering_bgp_management property of a FastConnectProviderService. + #: This constant has a value of "PROVIDER_MANAGED" + PUBLIC_PEERING_BGP_MANAGEMENT_PROVIDER_MANAGED = "PROVIDER_MANAGED" + + #: A constant which can be used with the public_peering_bgp_management property of a FastConnectProviderService. + #: This constant has a value of "ORACLE_MANAGED" + PUBLIC_PEERING_BGP_MANAGEMENT_ORACLE_MANAGED = "ORACLE_MANAGED" + + #: A constant which can be used with the supported_virtual_circuit_types property of a FastConnectProviderService. + #: This constant has a value of "PUBLIC" + SUPPORTED_VIRTUAL_CIRCUIT_TYPES_PUBLIC = "PUBLIC" + + #: A constant which can be used with the supported_virtual_circuit_types property of a FastConnectProviderService. + #: This constant has a value of "PRIVATE" + SUPPORTED_VIRTUAL_CIRCUIT_TYPES_PRIVATE = "PRIVATE" + + #: A constant which can be used with the type property of a FastConnectProviderService. + #: This constant has a value of "LAYER2" + TYPE_LAYER2 = "LAYER2" + + #: A constant which can be used with the type property of a FastConnectProviderService. + #: This constant has a value of "LAYER3" + TYPE_LAYER3 = "LAYER3" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/get_public_ip_by_ip_address_details.py b/src/oci/core/models/get_public_ip_by_ip_address_details.py index ada17823c6..fe52ccfd3d 100644 --- a/src/oci/core/models/get_public_ip_by_ip_address_details.py +++ b/src/oci/core/models/get_public_ip_by_ip_address_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class GetPublicIpByIpAddressDetails(object): + """ + IP address of the public IP. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/get_public_ip_by_private_ip_id_details.py b/src/oci/core/models/get_public_ip_by_private_ip_id_details.py index 3a2d269cea..e18463193e 100644 --- a/src/oci/core/models/get_public_ip_by_private_ip_id_details.py +++ b/src/oci/core/models/get_public_ip_by_private_ip_id_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class GetPublicIpByPrivateIpIdDetails(object): + """ + Details of the private IP that the public IP is assigned to. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/i_scsi_volume_attachment.py b/src/oci/core/models/i_scsi_volume_attachment.py index 52c04c3d95..38e160250b 100644 --- a/src/oci/core/models/i_scsi_volume_attachment.py +++ b/src/oci/core/models/i_scsi_volume_attachment.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class IScsiVolumeAttachment(VolumeAttachment): + """ + An ISCSI volume attachment. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/icmp_options.py b/src/oci/core/models/icmp_options.py index b5bd9f5f5c..18049381b1 100644 --- a/src/oci/core/models/icmp_options.py +++ b/src/oci/core/models/icmp_options.py @@ -8,6 +8,17 @@ @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. + + __ http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/image.py b/src/oci/core/models/image.py index 60b7c3c153..25b07141ec 100644 --- a/src/oci/core/models/image.py +++ b/src/oci/core/models/image.py @@ -8,6 +8,53 @@ @init_model_state_from_kwargs class Image(object): + """ + A boot disk image for launching an instance. For more information, see + `Overview of the Compute Service`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Concepts/computeoverview.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the launch_mode property of a Image. + #: This constant has a value of "NATIVE" + LAUNCH_MODE_NATIVE = "NATIVE" + + #: A constant which can be used with the launch_mode property of a Image. + #: This constant has a value of "EMULATED" + LAUNCH_MODE_EMULATED = "EMULATED" + + #: A constant which can be used with the launch_mode property of a Image. + #: This constant has a value of "CUSTOM" + LAUNCH_MODE_CUSTOM = "CUSTOM" + + #: A constant which can be used with the lifecycle_state property of a Image. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a Image. + #: This constant has a value of "IMPORTING" + LIFECYCLE_STATE_IMPORTING = "IMPORTING" + + #: A constant which can be used with the lifecycle_state property of a Image. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a Image. + #: This constant has a value of "EXPORTING" + LIFECYCLE_STATE_EXPORTING = "EXPORTING" + + #: A constant which can be used with the lifecycle_state property of a Image. + #: This constant has a value of "DISABLED" + LIFECYCLE_STATE_DISABLED = "DISABLED" + + #: A constant which can be used with the lifecycle_state property of a Image. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/image_source_details.py b/src/oci/core/models/image_source_details.py index 505538dbce..d03da3e32d 100644 --- a/src/oci/core/models/image_source_details.py +++ b/src/oci/core/models/image_source_details.py @@ -8,6 +8,17 @@ @init_model_state_from_kwargs class ImageSourceDetails(object): + """ + ImageSourceDetails model. + """ + + #: A constant which can be used with the source_image_type property of a ImageSourceDetails. + #: This constant has a value of "QCOW2" + SOURCE_IMAGE_TYPE_QCOW2 = "QCOW2" + + #: A constant which can be used with the source_image_type property of a ImageSourceDetails. + #: This constant has a value of "VMDK" + SOURCE_IMAGE_TYPE_VMDK = "VMDK" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/image_source_via_object_storage_tuple_details.py b/src/oci/core/models/image_source_via_object_storage_tuple_details.py index cebc1a0c96..86aa489743 100644 --- a/src/oci/core/models/image_source_via_object_storage_tuple_details.py +++ b/src/oci/core/models/image_source_via_object_storage_tuple_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class ImageSourceViaObjectStorageTupleDetails(ImageSourceDetails): + """ + ImageSourceViaObjectStorageTupleDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/image_source_via_object_storage_uri_details.py b/src/oci/core/models/image_source_via_object_storage_uri_details.py index 23811fbd91..13825ac463 100644 --- a/src/oci/core/models/image_source_via_object_storage_uri_details.py +++ b/src/oci/core/models/image_source_via_object_storage_uri_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class ImageSourceViaObjectStorageUriDetails(ImageSourceDetails): + """ + ImageSourceViaObjectStorageUriDetails model. + """ 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 3cb5d3a305..79ecab4fe7 100644 --- a/src/oci/core/models/ingress_security_rule.py +++ b/src/oci/core/models/ingress_security_rule.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class IngressSecurityRule(object): + """ + A rule for allowing inbound IP packets. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/instance.py b/src/oci/core/models/instance.py index 553f334799..637bfed5da 100644 --- a/src/oci/core/models/instance.py +++ b/src/oci/core/models/instance.py @@ -8,6 +8,63 @@ @init_model_state_from_kwargs class Instance(object): + """ + A compute host. The image used to launch the instance determines its operating system and other + software. The shape specified during the launch process determines the number of CPUs and memory + allocated to the instance. For more information, see + `Overview of the Compute Service`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Concepts/computeoverview.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the launch_mode property of a Instance. + #: This constant has a value of "NATIVE" + LAUNCH_MODE_NATIVE = "NATIVE" + + #: A constant which can be used with the launch_mode property of a Instance. + #: This constant has a value of "EMULATED" + LAUNCH_MODE_EMULATED = "EMULATED" + + #: A constant which can be used with the launch_mode property of a Instance. + #: This constant has a value of "CUSTOM" + LAUNCH_MODE_CUSTOM = "CUSTOM" + + #: A constant which can be used with the lifecycle_state property of a Instance. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a Instance. + #: This constant has a value of "RUNNING" + LIFECYCLE_STATE_RUNNING = "RUNNING" + + #: A constant which can be used with the lifecycle_state property of a Instance. + #: This constant has a value of "STARTING" + LIFECYCLE_STATE_STARTING = "STARTING" + + #: A constant which can be used with the lifecycle_state property of a Instance. + #: This constant has a value of "STOPPING" + LIFECYCLE_STATE_STOPPING = "STOPPING" + + #: A constant which can be used with the lifecycle_state property of a Instance. + #: This constant has a value of "STOPPED" + LIFECYCLE_STATE_STOPPED = "STOPPED" + + #: A constant which can be used with the lifecycle_state property of a Instance. + #: This constant has a value of "CREATING_IMAGE" + LIFECYCLE_STATE_CREATING_IMAGE = "CREATING_IMAGE" + + #: A constant which can be used with the lifecycle_state property of a Instance. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a Instance. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/instance_console_connection.py b/src/oci/core/models/instance_console_connection.py index b064be36ba..dc73d2ef7b 100644 --- a/src/oci/core/models/instance_console_connection.py +++ b/src/oci/core/models/instance_console_connection.py @@ -8,6 +8,35 @@ @init_model_state_from_kwargs class InstanceConsoleConnection(object): + """ + The `InstanceConsoleConnection` API provides you with console access to virtual machine (VM) instances, + enabling you to troubleshoot malfunctioning instances remotely. + + For more information about console access, see + `Accessing the Console`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/References/serialconsole.htm + """ + + #: A constant which can be used with the lifecycle_state property of a InstanceConsoleConnection. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a InstanceConsoleConnection. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a InstanceConsoleConnection. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a InstanceConsoleConnection. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a InstanceConsoleConnection. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/instance_credentials.py b/src/oci/core/models/instance_credentials.py index 4a9239635c..9ffb1f7fff 100644 --- a/src/oci/core/models/instance_credentials.py +++ b/src/oci/core/models/instance_credentials.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class InstanceCredentials(object): + """ + The credentials for a particular instance. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/instance_source_details.py b/src/oci/core/models/instance_source_details.py index cb5c31038f..d837e22ea1 100644 --- a/src/oci/core/models/instance_source_details.py +++ b/src/oci/core/models/instance_source_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class InstanceSourceDetails(object): + """ + InstanceSourceDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/instance_source_via_boot_volume_details.py b/src/oci/core/models/instance_source_via_boot_volume_details.py index 2ae01cb2d6..606932851f 100644 --- a/src/oci/core/models/instance_source_via_boot_volume_details.py +++ b/src/oci/core/models/instance_source_via_boot_volume_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class InstanceSourceViaBootVolumeDetails(InstanceSourceDetails): + """ + InstanceSourceViaBootVolumeDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/instance_source_via_image_details.py b/src/oci/core/models/instance_source_via_image_details.py index e417c2502a..857b3f8f62 100644 --- a/src/oci/core/models/instance_source_via_image_details.py +++ b/src/oci/core/models/instance_source_via_image_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class InstanceSourceViaImageDetails(InstanceSourceDetails): + """ + InstanceSourceViaImageDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/internet_gateway.py b/src/oci/core/models/internet_gateway.py index e9180e4362..5610cdda4e 100644 --- a/src/oci/core/models/internet_gateway.py +++ b/src/oci/core/models/internet_gateway.py @@ -8,6 +8,34 @@ @init_model_state_from_kwargs class InternetGateway(object): + """ + Represents a router that connects the edge of a VCN with the Internet. For an example scenario + that uses an Internet Gateway, see + `Typical Networking Service Scenarios`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm#scenarios + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a InternetGateway. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a InternetGateway. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a InternetGateway. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a InternetGateway. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/ip_sec_connection.py b/src/oci/core/models/ip_sec_connection.py index f15ee200af..28e658f357 100644 --- a/src/oci/core/models/ip_sec_connection.py +++ b/src/oci/core/models/ip_sec_connection.py @@ -8,6 +8,35 @@ @init_model_state_from_kwargs class IPSecConnection(object): + """ + A connection between a DRG and CPE. This connection consists of multiple IPSec + tunnels. Creating this connection is one of the steps required when setting up + an IPSec VPN. For more information, see + `Overview of the Networking Service`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a IPSecConnection. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a IPSecConnection. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a IPSecConnection. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a IPSecConnection. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/ip_sec_connection_device_config.py b/src/oci/core/models/ip_sec_connection_device_config.py index 8fab2930b4..c92ea9951f 100644 --- a/src/oci/core/models/ip_sec_connection_device_config.py +++ b/src/oci/core/models/ip_sec_connection_device_config.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class IPSecConnectionDeviceConfig(object): + """ + Information about the IPSecConnection device configuration. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/ip_sec_connection_device_status.py b/src/oci/core/models/ip_sec_connection_device_status.py index c9be1a1555..2643505d71 100644 --- a/src/oci/core/models/ip_sec_connection_device_status.py +++ b/src/oci/core/models/ip_sec_connection_device_status.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class IPSecConnectionDeviceStatus(object): + """ + Status of the IPSec connection. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/launch_instance_details.py b/src/oci/core/models/launch_instance_details.py index 1311261e18..f32efbd98d 100644 --- a/src/oci/core/models/launch_instance_details.py +++ b/src/oci/core/models/launch_instance_details.py @@ -8,6 +8,10 @@ @init_model_state_from_kwargs class LaunchInstanceDetails(object): + """ + Instance launch details. + Use the `sourceDetails` parameter to specify whether a boot volume or an image should be used to launch a new instance. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/launch_options.py b/src/oci/core/models/launch_options.py index d98eeca08d..628f9878df 100644 --- a/src/oci/core/models/launch_options.py +++ b/src/oci/core/models/launch_options.py @@ -8,6 +8,57 @@ @init_model_state_from_kwargs class LaunchOptions(object): + """ + Options for tuning compatibility and performance of VM shapes. + """ + + #: A constant which can be used with the boot_volume_type property of a LaunchOptions. + #: This constant has a value of "ISCSI" + BOOT_VOLUME_TYPE_ISCSI = "ISCSI" + + #: A constant which can be used with the boot_volume_type property of a LaunchOptions. + #: This constant has a value of "SCSI" + BOOT_VOLUME_TYPE_SCSI = "SCSI" + + #: A constant which can be used with the boot_volume_type property of a LaunchOptions. + #: This constant has a value of "IDE" + BOOT_VOLUME_TYPE_IDE = "IDE" + + #: A constant which can be used with the boot_volume_type property of a LaunchOptions. + #: This constant has a value of "VFIO" + BOOT_VOLUME_TYPE_VFIO = "VFIO" + + #: A constant which can be used with the firmware property of a LaunchOptions. + #: This constant has a value of "BIOS" + FIRMWARE_BIOS = "BIOS" + + #: A constant which can be used with the firmware property of a LaunchOptions. + #: This constant has a value of "UEFI_64" + FIRMWARE_UEFI_64 = "UEFI_64" + + #: A constant which can be used with the network_type property of a LaunchOptions. + #: This constant has a value of "E1000" + NETWORK_TYPE_E1000 = "E1000" + + #: A constant which can be used with the network_type property of a LaunchOptions. + #: This constant has a value of "VFIO" + NETWORK_TYPE_VFIO = "VFIO" + + #: A constant which can be used with the remote_data_volume_type property of a LaunchOptions. + #: This constant has a value of "ISCSI" + REMOTE_DATA_VOLUME_TYPE_ISCSI = "ISCSI" + + #: A constant which can be used with the remote_data_volume_type property of a LaunchOptions. + #: This constant has a value of "SCSI" + REMOTE_DATA_VOLUME_TYPE_SCSI = "SCSI" + + #: A constant which can be used with the remote_data_volume_type property of a LaunchOptions. + #: This constant has a value of "IDE" + REMOTE_DATA_VOLUME_TYPE_IDE = "IDE" + + #: A constant which can be used with the remote_data_volume_type property of a LaunchOptions. + #: This constant has a value of "VFIO" + REMOTE_DATA_VOLUME_TYPE_VFIO = "VFIO" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/letter_of_authority.py b/src/oci/core/models/letter_of_authority.py index 405384423c..596576bcc2 100644 --- a/src/oci/core/models/letter_of_authority.py +++ b/src/oci/core/models/letter_of_authority.py @@ -8,6 +8,18 @@ @init_model_state_from_kwargs class LetterOfAuthority(object): + """ + The Letter of Authority for the cross-connect. You must submit this letter when + requesting cabling for the cross-connect at the FastConnect location. + """ + + #: A constant which can be used with the circuit_type property of a LetterOfAuthority. + #: This constant has a value of "Single_mode_LC" + CIRCUIT_TYPE_SINGLE_MODE_LC = "Single_mode_LC" + + #: A constant which can be used with the circuit_type property of a LetterOfAuthority. + #: This constant has a value of "Single_mode_SC" + CIRCUIT_TYPE_SINGLE_MODE_SC = "Single_mode_SC" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/local_peering_gateway.py b/src/oci/core/models/local_peering_gateway.py index 9cc6841d4d..6de87579ef 100644 --- a/src/oci/core/models/local_peering_gateway.py +++ b/src/oci/core/models/local_peering_gateway.py @@ -8,6 +8,56 @@ @init_model_state_from_kwargs class LocalPeeringGateway(object): + """ + A local peering gateway (LPG) is an object on a VCN that lets that VCN peer + with another VCN in the same region. *Peering* means that the two VCNs can + communicate using private IP addresses, but without the traffic traversing the + internet or routing through your on-premises network. For more information, + see `VCN Peering`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/VCNpeering.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a LocalPeeringGateway. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a LocalPeeringGateway. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a LocalPeeringGateway. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a LocalPeeringGateway. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" + + #: A constant which can be used with the peering_status property of a LocalPeeringGateway. + #: This constant has a value of "INVALID" + PEERING_STATUS_INVALID = "INVALID" + + #: A constant which can be used with the peering_status property of a LocalPeeringGateway. + #: This constant has a value of "NEW" + PEERING_STATUS_NEW = "NEW" + + #: A constant which can be used with the peering_status property of a LocalPeeringGateway. + #: This constant has a value of "PEERED" + PEERING_STATUS_PEERED = "PEERED" + + #: A constant which can be used with the peering_status property of a LocalPeeringGateway. + #: This constant has a value of "PENDING" + PEERING_STATUS_PENDING = "PENDING" + + #: A constant which can be used with the peering_status property of a LocalPeeringGateway. + #: This constant has a value of "REVOKED" + PEERING_STATUS_REVOKED = "REVOKED" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/paravirtualized_volume_attachment.py b/src/oci/core/models/paravirtualized_volume_attachment.py index 9d58f48e84..8f20cfe4bb 100644 --- a/src/oci/core/models/paravirtualized_volume_attachment.py +++ b/src/oci/core/models/paravirtualized_volume_attachment.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class ParavirtualizedVolumeAttachment(VolumeAttachment): + """ + A paravirtualized volume attachment. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/peer_region_for_remote_peering.py b/src/oci/core/models/peer_region_for_remote_peering.py index 389bf5ee90..af22236ba0 100644 --- a/src/oci/core/models/peer_region_for_remote_peering.py +++ b/src/oci/core/models/peer_region_for_remote_peering.py @@ -8,6 +8,11 @@ @init_model_state_from_kwargs class PeerRegionForRemotePeering(object): + """ + Details about a region that supports remote VCN peering. For more information, see `VCN Peering`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/VCNpeering.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/port_range.py b/src/oci/core/models/port_range.py index e3c054e87c..1cacb3dd0c 100644 --- a/src/oci/core/models/port_range.py +++ b/src/oci/core/models/port_range.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class PortRange(object): + """ + PortRange model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/private_ip.py b/src/oci/core/models/private_ip.py index 41d18041ae..e16f5902e7 100644 --- a/src/oci/core/models/private_ip.py +++ b/src/oci/core/models/private_ip.py @@ -8,6 +8,38 @@ @init_model_state_from_kwargs class PrivateIp(object): + """ + A *private IP* is a conceptual term that refers to a private IP address and related properties. + The `privateIp` object is the API representation of a private IP. + + Each instance has a *primary private IP* that is automatically created and + assigned to the primary VNIC during instance launch. If you add a secondary + VNIC to the instance, it also automatically gets a primary private IP. You + can't remove a primary private IP from its VNIC. The primary private IP is + automatically deleted when the VNIC is terminated. + + You can add *secondary private IPs* to a VNIC after it's created. For more + information, see the `privateIp` operations and also + `IP Addresses`__. + + **Note:** Only + :func:`list_private_ips` and + :func:`get_private_ip` work with + *primary* private IPs. To create and update primary private IPs, you instead + work with instance and VNIC operations. For example, a primary private IP's + properties come from the values you specify in + :class:`CreateVnicDetails` when calling either + :func:`launch_instance` or + :func:`attach_vnic`. To update the hostname + for a primary private IP, you use :func:`update_vnic`. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingIPaddresses.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/public_ip.py b/src/oci/core/models/public_ip.py index 3ed6299426..4750c01d99 100644 --- a/src/oci/core/models/public_ip.py +++ b/src/oci/core/models/public_ip.py @@ -8,6 +8,67 @@ @init_model_state_from_kwargs class PublicIp(object): + """ + A *public IP* is a conceptual term that refers to a public IP address and related properties. + The `publicIp` object is the API representation of a public IP. + + There are two types of public IPs: + 1. Ephemeral + 2. Reserved + + For more information and comparison of the two types, + see `Public IP Addresses`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingpublicIPs.htm + """ + + #: A constant which can be used with the lifecycle_state property of a PublicIp. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a PublicIp. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a PublicIp. + #: This constant has a value of "ASSIGNING" + LIFECYCLE_STATE_ASSIGNING = "ASSIGNING" + + #: A constant which can be used with the lifecycle_state property of a PublicIp. + #: This constant has a value of "ASSIGNED" + LIFECYCLE_STATE_ASSIGNED = "ASSIGNED" + + #: A constant which can be used with the lifecycle_state property of a PublicIp. + #: This constant has a value of "UNASSIGNING" + LIFECYCLE_STATE_UNASSIGNING = "UNASSIGNING" + + #: A constant which can be used with the lifecycle_state property of a PublicIp. + #: This constant has a value of "UNASSIGNED" + LIFECYCLE_STATE_UNASSIGNED = "UNASSIGNED" + + #: A constant which can be used with the lifecycle_state property of a PublicIp. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a PublicIp. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" + + #: A constant which can be used with the lifetime property of a PublicIp. + #: This constant has a value of "EPHEMERAL" + LIFETIME_EPHEMERAL = "EPHEMERAL" + + #: A constant which can be used with the lifetime property of a PublicIp. + #: This constant has a value of "RESERVED" + LIFETIME_RESERVED = "RESERVED" + + #: A constant which can be used with the scope property of a PublicIp. + #: This constant has a value of "REGION" + SCOPE_REGION = "REGION" + + #: A constant which can be used with the scope property of a PublicIp. + #: This constant has a value of "AVAILABILITY_DOMAIN" + SCOPE_AVAILABILITY_DOMAIN = "AVAILABILITY_DOMAIN" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/remote_peering_connection.py b/src/oci/core/models/remote_peering_connection.py index 1ec9fb6eb9..d5408e5702 100644 --- a/src/oci/core/models/remote_peering_connection.py +++ b/src/oci/core/models/remote_peering_connection.py @@ -8,6 +8,56 @@ @init_model_state_from_kwargs class RemotePeeringConnection(object): + """ + A remote peering connection (RPC) is an object on a DRG that lets the VCN that is attached + to the DRG peer with a VCN in a different region. *Peering* means that the two VCNs can + communicate using private IP addresses, but without the traffic traversing the internet or + routing through your on-premises network. For more information, see + `VCN Peering`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/VCNpeering.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a RemotePeeringConnection. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a RemotePeeringConnection. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a RemotePeeringConnection. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a RemotePeeringConnection. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" + + #: A constant which can be used with the peering_status property of a RemotePeeringConnection. + #: This constant has a value of "INVALID" + PEERING_STATUS_INVALID = "INVALID" + + #: A constant which can be used with the peering_status property of a RemotePeeringConnection. + #: This constant has a value of "NEW" + PEERING_STATUS_NEW = "NEW" + + #: A constant which can be used with the peering_status property of a RemotePeeringConnection. + #: This constant has a value of "PENDING" + PEERING_STATUS_PENDING = "PENDING" + + #: A constant which can be used with the peering_status property of a RemotePeeringConnection. + #: This constant has a value of "PEERED" + PEERING_STATUS_PEERED = "PEERED" + + #: A constant which can be used with the peering_status property of a RemotePeeringConnection. + #: This constant has a value of "REVOKED" + PEERING_STATUS_REVOKED = "REVOKED" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/route_rule.py b/src/oci/core/models/route_rule.py index d19b11473d..0d8ae11327 100644 --- a/src/oci/core/models/route_rule.py +++ b/src/oci/core/models/route_rule.py @@ -8,6 +8,10 @@ @init_model_state_from_kwargs class RouteRule(object): + """ + A mapping between a destination IP address range and a virtual device to route matching + packets to (a target). + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/route_table.py b/src/oci/core/models/route_table.py index 4a5b85e9e6..d176827800 100644 --- a/src/oci/core/models/route_table.py +++ b/src/oci/core/models/route_table.py @@ -8,6 +8,34 @@ @init_model_state_from_kwargs class RouteTable(object): + """ + A collection of `RouteRule` objects, which are used to route packets + based on destination IP to a particular network entity. For more information, see + `Overview of the Networking Service`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a RouteTable. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a RouteTable. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a RouteTable. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a RouteTable. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/security_list.py b/src/oci/core/models/security_list.py index 7ca3a2061f..abca1356ab 100644 --- a/src/oci/core/models/security_list.py +++ b/src/oci/core/models/security_list.py @@ -8,6 +8,40 @@ @init_model_state_from_kwargs class SecurityList(object): + """ + A set of virtual firewall rules for your VCN. Security lists are configured at the subnet + level, but the rules are applied to the ingress and egress traffic for the individual instances + in the subnet. The rules can be stateful or stateless. For more information, see + `Security Lists`__. + + **Important:** Oracle Cloud Infrastructure Compute service images automatically include firewall rules (for example, + Linux iptables, Windows firewall). If there are issues with some type of access to an instance, + make sure both the security lists associated with the instance's subnet and the instance's + firewall rules are set correctly. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/securitylists.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a SecurityList. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a SecurityList. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a SecurityList. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a SecurityList. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/shape.py b/src/oci/core/models/shape.py index 334703b549..cfd9fd4e60 100644 --- a/src/oci/core/models/shape.py +++ b/src/oci/core/models/shape.py @@ -8,6 +8,12 @@ @init_model_state_from_kwargs class Shape(object): + """ + A compute instance shape that can be used in :func:`launch_instance`. + For more information, see `Overview of the Compute Service`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Concepts/computeoverview.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/subnet.py b/src/oci/core/models/subnet.py index c0f59d5894..5acf6a85f8 100644 --- a/src/oci/core/models/subnet.py +++ b/src/oci/core/models/subnet.py @@ -8,6 +8,37 @@ @init_model_state_from_kwargs class Subnet(object): + """ + A logical subdivision of a VCN. Each subnet exists in a single Availability Domain and + consists of a contiguous range of IP addresses that do not overlap with + other subnets in the VCN. Example: 172.16.1.0/24. For more information, see + `Overview of the Networking Service`__ and + `VCNs and Subnets`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVCNs.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a Subnet. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a Subnet. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a Subnet. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a Subnet. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/tcp_options.py b/src/oci/core/models/tcp_options.py index 32139b50fe..064fc683cb 100644 --- a/src/oci/core/models/tcp_options.py +++ b/src/oci/core/models/tcp_options.py @@ -8,6 +8,10 @@ @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. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/tunnel_config.py b/src/oci/core/models/tunnel_config.py index e9299a834e..9375f1a403 100644 --- a/src/oci/core/models/tunnel_config.py +++ b/src/oci/core/models/tunnel_config.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class TunnelConfig(object): + """ + Specific connection details for an IPSec tunnel. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/tunnel_status.py b/src/oci/core/models/tunnel_status.py index 66192ffabd..3ecddbcb6b 100644 --- a/src/oci/core/models/tunnel_status.py +++ b/src/oci/core/models/tunnel_status.py @@ -8,6 +8,21 @@ @init_model_state_from_kwargs class TunnelStatus(object): + """ + Specific connection details for an IPSec tunnel. + """ + + #: A constant which can be used with the lifecycle_state property of a TunnelStatus. + #: This constant has a value of "UP" + LIFECYCLE_STATE_UP = "UP" + + #: A constant which can be used with the lifecycle_state property of a TunnelStatus. + #: This constant has a value of "DOWN" + LIFECYCLE_STATE_DOWN = "DOWN" + + #: A constant which can be used with the lifecycle_state property of a TunnelStatus. + #: This constant has a value of "DOWN_FOR_MAINTENANCE" + LIFECYCLE_STATE_DOWN_FOR_MAINTENANCE = "DOWN_FOR_MAINTENANCE" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/udp_options.py b/src/oci/core/models/udp_options.py index 15435de597..3ce680c8a7 100644 --- a/src/oci/core/models/udp_options.py +++ b/src/oci/core/models/udp_options.py @@ -8,6 +8,10 @@ @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. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/update_boot_volume_details.py b/src/oci/core/models/update_boot_volume_details.py index bf0c86020c..1c6a562ae6 100644 --- a/src/oci/core/models/update_boot_volume_details.py +++ b/src/oci/core/models/update_boot_volume_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateBootVolumeDetails(object): + """ + UpdateBootVolumeDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/update_console_history_details.py b/src/oci/core/models/update_console_history_details.py index a2cbdcb120..2245655f2e 100644 --- a/src/oci/core/models/update_console_history_details.py +++ b/src/oci/core/models/update_console_history_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateConsoleHistoryDetails(object): + """ + UpdateConsoleHistoryDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/update_cpe_details.py b/src/oci/core/models/update_cpe_details.py index ee3b9ebe96..7f34996a01 100644 --- a/src/oci/core/models/update_cpe_details.py +++ b/src/oci/core/models/update_cpe_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateCpeDetails(object): + """ + UpdateCpeDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/update_cross_connect_details.py b/src/oci/core/models/update_cross_connect_details.py index 727d232b35..0b79b61af6 100644 --- a/src/oci/core/models/update_cross_connect_details.py +++ b/src/oci/core/models/update_cross_connect_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateCrossConnectDetails(object): + """ + Update a CrossConnect + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/update_cross_connect_group_details.py b/src/oci/core/models/update_cross_connect_group_details.py index 060604c560..ddde576bb6 100644 --- a/src/oci/core/models/update_cross_connect_group_details.py +++ b/src/oci/core/models/update_cross_connect_group_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateCrossConnectGroupDetails(object): + """ + UpdateCrossConnectGroupDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/update_dhcp_details.py b/src/oci/core/models/update_dhcp_details.py index 9c30dc4305..18b5f0862b 100644 --- a/src/oci/core/models/update_dhcp_details.py +++ b/src/oci/core/models/update_dhcp_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateDhcpDetails(object): + """ + UpdateDhcpDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/update_drg_attachment_details.py b/src/oci/core/models/update_drg_attachment_details.py index 56c98ea51f..93561c7e46 100644 --- a/src/oci/core/models/update_drg_attachment_details.py +++ b/src/oci/core/models/update_drg_attachment_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateDrgAttachmentDetails(object): + """ + UpdateDrgAttachmentDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/update_drg_details.py b/src/oci/core/models/update_drg_details.py index 2453dfbfd5..eeed80e9ef 100644 --- a/src/oci/core/models/update_drg_details.py +++ b/src/oci/core/models/update_drg_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateDrgDetails(object): + """ + UpdateDrgDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/update_image_details.py b/src/oci/core/models/update_image_details.py index 656c203421..eab9066bb4 100644 --- a/src/oci/core/models/update_image_details.py +++ b/src/oci/core/models/update_image_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateImageDetails(object): + """ + UpdateImageDetails model. + """ 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 fea20f6264..40e6285dea 100644 --- a/src/oci/core/models/update_instance_details.py +++ b/src/oci/core/models/update_instance_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateInstanceDetails(object): + """ + UpdateInstanceDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/update_internet_gateway_details.py b/src/oci/core/models/update_internet_gateway_details.py index 074724c152..e6e30cba4f 100644 --- a/src/oci/core/models/update_internet_gateway_details.py +++ b/src/oci/core/models/update_internet_gateway_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateInternetGatewayDetails(object): + """ + UpdateInternetGatewayDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/update_ip_sec_connection_details.py b/src/oci/core/models/update_ip_sec_connection_details.py index ab55ef3fa3..48d1c76550 100644 --- a/src/oci/core/models/update_ip_sec_connection_details.py +++ b/src/oci/core/models/update_ip_sec_connection_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateIPSecConnectionDetails(object): + """ + UpdateIPSecConnectionDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/update_local_peering_gateway_details.py b/src/oci/core/models/update_local_peering_gateway_details.py index e941de5b61..9f8b7bbb55 100644 --- a/src/oci/core/models/update_local_peering_gateway_details.py +++ b/src/oci/core/models/update_local_peering_gateway_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateLocalPeeringGatewayDetails(object): + """ + UpdateLocalPeeringGatewayDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/update_private_ip_details.py b/src/oci/core/models/update_private_ip_details.py index 014476b1c1..72fb932873 100644 --- a/src/oci/core/models/update_private_ip_details.py +++ b/src/oci/core/models/update_private_ip_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdatePrivateIpDetails(object): + """ + UpdatePrivateIpDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/update_public_ip_details.py b/src/oci/core/models/update_public_ip_details.py index 78d4ec3844..f0f757e952 100644 --- a/src/oci/core/models/update_public_ip_details.py +++ b/src/oci/core/models/update_public_ip_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdatePublicIpDetails(object): + """ + UpdatePublicIpDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/update_remote_peering_connection_details.py b/src/oci/core/models/update_remote_peering_connection_details.py index 23ae75b487..026d269039 100644 --- a/src/oci/core/models/update_remote_peering_connection_details.py +++ b/src/oci/core/models/update_remote_peering_connection_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateRemotePeeringConnectionDetails(object): + """ + UpdateRemotePeeringConnectionDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/update_route_table_details.py b/src/oci/core/models/update_route_table_details.py index 0a2143eaa1..760610827d 100644 --- a/src/oci/core/models/update_route_table_details.py +++ b/src/oci/core/models/update_route_table_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateRouteTableDetails(object): + """ + UpdateRouteTableDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/update_security_list_details.py b/src/oci/core/models/update_security_list_details.py index 2d49c154a9..71cb00515e 100644 --- a/src/oci/core/models/update_security_list_details.py +++ b/src/oci/core/models/update_security_list_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateSecurityListDetails(object): + """ + UpdateSecurityListDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/update_subnet_details.py b/src/oci/core/models/update_subnet_details.py index 0908a04f98..f1c1cf8106 100644 --- a/src/oci/core/models/update_subnet_details.py +++ b/src/oci/core/models/update_subnet_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateSubnetDetails(object): + """ + UpdateSubnetDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/update_vcn_details.py b/src/oci/core/models/update_vcn_details.py index da8fa4ef50..32d8c3438c 100644 --- a/src/oci/core/models/update_vcn_details.py +++ b/src/oci/core/models/update_vcn_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateVcnDetails(object): + """ + UpdateVcnDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/update_virtual_circuit_details.py b/src/oci/core/models/update_virtual_circuit_details.py index 09cc475df0..b2603317ae 100644 --- a/src/oci/core/models/update_virtual_circuit_details.py +++ b/src/oci/core/models/update_virtual_circuit_details.py @@ -8,6 +8,17 @@ @init_model_state_from_kwargs class UpdateVirtualCircuitDetails(object): + """ + UpdateVirtualCircuitDetails model. + """ + + #: A constant which can be used with the provider_state property of a UpdateVirtualCircuitDetails. + #: This constant has a value of "ACTIVE" + PROVIDER_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the provider_state property of a UpdateVirtualCircuitDetails. + #: This constant has a value of "INACTIVE" + PROVIDER_STATE_INACTIVE = "INACTIVE" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/update_vnic_details.py b/src/oci/core/models/update_vnic_details.py index 7ff29025e4..e1f5d4111c 100644 --- a/src/oci/core/models/update_vnic_details.py +++ b/src/oci/core/models/update_vnic_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateVnicDetails(object): + """ + UpdateVnicDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/update_volume_backup_details.py b/src/oci/core/models/update_volume_backup_details.py index 38110ac1f3..d6902f517f 100644 --- a/src/oci/core/models/update_volume_backup_details.py +++ b/src/oci/core/models/update_volume_backup_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateVolumeBackupDetails(object): + """ + UpdateVolumeBackupDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/update_volume_details.py b/src/oci/core/models/update_volume_details.py index e54b4b65de..a0a0c95fd3 100644 --- a/src/oci/core/models/update_volume_details.py +++ b/src/oci/core/models/update_volume_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateVolumeDetails(object): + """ + UpdateVolumeDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/vcn.py b/src/oci/core/models/vcn.py index 8e6e872b19..ba2438d95c 100644 --- a/src/oci/core/models/vcn.py +++ b/src/oci/core/models/vcn.py @@ -8,6 +8,33 @@ @init_model_state_from_kwargs class Vcn(object): + """ + A Virtual Cloud Network (VCN). For more information, see + `Overview of the Networking Service`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a Vcn. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a Vcn. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a Vcn. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a Vcn. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/virtual_circuit.py b/src/oci/core/models/virtual_circuit.py index 82f008d95c..0035eccd7a 100644 --- a/src/oci/core/models/virtual_circuit.py +++ b/src/oci/core/models/virtual_circuit.py @@ -8,6 +8,110 @@ @init_model_state_from_kwargs class VirtualCircuit(object): + """ + For use with Oracle Cloud Infrastructure FastConnect. + + A virtual circuit is an isolated network path that runs over one or more physical + network connections to provide a single, logical connection between the edge router + on the customer's existing network and Oracle Cloud Infrastructure. *Private* + virtual circuits support private peering, and *public* virtual circuits support + public peering. For more information, see `FastConnect Overview`__. + + Each virtual circuit is made up of information shared between a customer, Oracle, + and a provider (if the customer is using FastConnect via a provider). Who fills in + a given property of a virtual circuit depends on whether the BGP session related to + that virtual circuit goes from the customer's edge router to Oracle, or from the provider's + edge router to Oracle. Also, in the case where the customer is using a provider, values + for some of the properties may not be present immediately, but may get filled in as the + provider and Oracle each do their part to provision the virtual circuit. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the bgp_management property of a VirtualCircuit. + #: This constant has a value of "CUSTOMER_MANAGED" + BGP_MANAGEMENT_CUSTOMER_MANAGED = "CUSTOMER_MANAGED" + + #: A constant which can be used with the bgp_management property of a VirtualCircuit. + #: This constant has a value of "PROVIDER_MANAGED" + BGP_MANAGEMENT_PROVIDER_MANAGED = "PROVIDER_MANAGED" + + #: A constant which can be used with the bgp_management property of a VirtualCircuit. + #: This constant has a value of "ORACLE_MANAGED" + BGP_MANAGEMENT_ORACLE_MANAGED = "ORACLE_MANAGED" + + #: A constant which can be used with the bgp_session_state property of a VirtualCircuit. + #: This constant has a value of "UP" + BGP_SESSION_STATE_UP = "UP" + + #: A constant which can be used with the bgp_session_state property of a VirtualCircuit. + #: This constant has a value of "DOWN" + BGP_SESSION_STATE_DOWN = "DOWN" + + #: A constant which can be used with the lifecycle_state property of a VirtualCircuit. + #: This constant has a value of "PENDING_PROVIDER" + LIFECYCLE_STATE_PENDING_PROVIDER = "PENDING_PROVIDER" + + #: A constant which can be used with the lifecycle_state property of a VirtualCircuit. + #: This constant has a value of "VERIFYING" + LIFECYCLE_STATE_VERIFYING = "VERIFYING" + + #: A constant which can be used with the lifecycle_state property of a VirtualCircuit. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a VirtualCircuit. + #: This constant has a value of "PROVISIONED" + LIFECYCLE_STATE_PROVISIONED = "PROVISIONED" + + #: A constant which can be used with the lifecycle_state property of a VirtualCircuit. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + #: A constant which can be used with the lifecycle_state property of a VirtualCircuit. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the lifecycle_state property of a VirtualCircuit. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a VirtualCircuit. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" + + #: A constant which can be used with the provider_state property of a VirtualCircuit. + #: This constant has a value of "ACTIVE" + PROVIDER_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the provider_state property of a VirtualCircuit. + #: This constant has a value of "INACTIVE" + PROVIDER_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the service_type property of a VirtualCircuit. + #: This constant has a value of "COLOCATED" + SERVICE_TYPE_COLOCATED = "COLOCATED" + + #: A constant which can be used with the service_type property of a VirtualCircuit. + #: This constant has a value of "LAYER2" + SERVICE_TYPE_LAYER2 = "LAYER2" + + #: A constant which can be used with the service_type property of a VirtualCircuit. + #: This constant has a value of "LAYER3" + SERVICE_TYPE_LAYER3 = "LAYER3" + + #: A constant which can be used with the type property of a VirtualCircuit. + #: This constant has a value of "PUBLIC" + TYPE_PUBLIC = "PUBLIC" + + #: A constant which can be used with the type property of a VirtualCircuit. + #: This constant has a value of "PRIVATE" + TYPE_PRIVATE = "PRIVATE" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/virtual_circuit_bandwidth_shape.py b/src/oci/core/models/virtual_circuit_bandwidth_shape.py index 68ff05de47..b0d0ccddb4 100644 --- a/src/oci/core/models/virtual_circuit_bandwidth_shape.py +++ b/src/oci/core/models/virtual_circuit_bandwidth_shape.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class VirtualCircuitBandwidthShape(object): + """ + An individual bandwidth level for virtual circuits. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/virtual_circuit_public_prefix.py b/src/oci/core/models/virtual_circuit_public_prefix.py index 9cd9a22395..ee47039da2 100644 --- a/src/oci/core/models/virtual_circuit_public_prefix.py +++ b/src/oci/core/models/virtual_circuit_public_prefix.py @@ -8,6 +8,25 @@ @init_model_state_from_kwargs class VirtualCircuitPublicPrefix(object): + """ + A public IP prefix and its details. With a public virtual circuit, the customer + specifies the customer-owned public IP prefixes to advertise across the connection. + For more information, see `FastConnect Overview`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm + """ + + #: A constant which can be used with the verification_state property of a VirtualCircuitPublicPrefix. + #: This constant has a value of "IN_PROGRESS" + VERIFICATION_STATE_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the verification_state property of a VirtualCircuitPublicPrefix. + #: This constant has a value of "COMPLETED" + VERIFICATION_STATE_COMPLETED = "COMPLETED" + + #: A constant which can be used with the verification_state property of a VirtualCircuitPublicPrefix. + #: This constant has a value of "FAILED" + VERIFICATION_STATE_FAILED = "FAILED" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/vnic.py b/src/oci/core/models/vnic.py index 7f5c729d9f..8e9fa0dac5 100644 --- a/src/oci/core/models/vnic.py +++ b/src/oci/core/models/vnic.py @@ -8,6 +8,43 @@ @init_model_state_from_kwargs class Vnic(object): + """ + A virtual network interface card. Each VNIC resides in a subnet in a VCN. + An instance attaches to a VNIC to obtain a network connection into the VCN + through that subnet. Each instance has a *primary VNIC* that is automatically + created and attached during launch. You can add *secondary VNICs* to an + instance after it's launched. For more information, see + `Virtual Network Interface Cards (VNICs)`__. + + Each VNIC has a *primary private IP* that is automatically assigned during launch. + You can add *secondary private IPs* to a VNIC after it's created. For more + information, see :func:`create_private_ip` and + `IP Addresses`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVNICs.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingIPaddresses.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a Vnic. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a Vnic. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a Vnic. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a Vnic. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/vnic_attachment.py b/src/oci/core/models/vnic_attachment.py index 19f25da7e6..387210b269 100644 --- a/src/oci/core/models/vnic_attachment.py +++ b/src/oci/core/models/vnic_attachment.py @@ -8,6 +8,28 @@ @init_model_state_from_kwargs class VnicAttachment(object): + """ + Represents an attachment between a VNIC and an instance. For more information, see + `Virtual Network Interface Cards (VNICs)`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVNICs.htm + """ + + #: A constant which can be used with the lifecycle_state property of a VnicAttachment. + #: This constant has a value of "ATTACHING" + LIFECYCLE_STATE_ATTACHING = "ATTACHING" + + #: A constant which can be used with the lifecycle_state property of a VnicAttachment. + #: This constant has a value of "ATTACHED" + LIFECYCLE_STATE_ATTACHED = "ATTACHED" + + #: A constant which can be used with the lifecycle_state property of a VnicAttachment. + #: This constant has a value of "DETACHING" + LIFECYCLE_STATE_DETACHING = "DETACHING" + + #: A constant which can be used with the lifecycle_state property of a VnicAttachment. + #: This constant has a value of "DETACHED" + LIFECYCLE_STATE_DETACHED = "DETACHED" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/volume.py b/src/oci/core/models/volume.py index 00abde197a..86332c218b 100644 --- a/src/oci/core/models/volume.py +++ b/src/oci/core/models/volume.py @@ -8,6 +8,42 @@ @init_model_state_from_kwargs class Volume(object): + """ + A detachable block volume device that allows you to dynamically expand + the storage capacity of an instance. For more information, see + `Overview of Cloud Volume Storage`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/overview.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a Volume. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a Volume. + #: This constant has a value of "RESTORING" + LIFECYCLE_STATE_RESTORING = "RESTORING" + + #: A constant which can be used with the lifecycle_state property of a Volume. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a Volume. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a Volume. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" + + #: A constant which can be used with the lifecycle_state property of a Volume. + #: This constant has a value of "FAULTY" + LIFECYCLE_STATE_FAULTY = "FAULTY" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/volume_attachment.py b/src/oci/core/models/volume_attachment.py index b85b5bd0e1..976c21d4d4 100644 --- a/src/oci/core/models/volume_attachment.py +++ b/src/oci/core/models/volume_attachment.py @@ -8,6 +8,32 @@ @init_model_state_from_kwargs class VolumeAttachment(object): + """ + A base object for all types of attachments between a storage volume and an instance. + For specific details about iSCSI attachments, see + :class:`IScsiVolumeAttachment`. + + For general information about volume attachments, see + `Overview of Block Volume Storage`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/overview.htm + """ + + #: A constant which can be used with the lifecycle_state property of a VolumeAttachment. + #: This constant has a value of "ATTACHING" + LIFECYCLE_STATE_ATTACHING = "ATTACHING" + + #: A constant which can be used with the lifecycle_state property of a VolumeAttachment. + #: This constant has a value of "ATTACHED" + LIFECYCLE_STATE_ATTACHED = "ATTACHED" + + #: A constant which can be used with the lifecycle_state property of a VolumeAttachment. + #: This constant has a value of "DETACHING" + LIFECYCLE_STATE_DETACHING = "DETACHING" + + #: A constant which can be used with the lifecycle_state property of a VolumeAttachment. + #: This constant has a value of "DETACHED" + LIFECYCLE_STATE_DETACHED = "DETACHED" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/volume_backup.py b/src/oci/core/models/volume_backup.py index b71e5b107c..6e838decda 100644 --- a/src/oci/core/models/volume_backup.py +++ b/src/oci/core/models/volume_backup.py @@ -8,6 +8,58 @@ @init_model_state_from_kwargs class VolumeBackup(object): + """ + A point-in-time copy of a volume that can then be used to create a new block volume + or recover a block volume. For more information, see + `Overview of Cloud Volume Storage`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/overview.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a VolumeBackup. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a VolumeBackup. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a VolumeBackup. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a VolumeBackup. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" + + #: A constant which can be used with the lifecycle_state property of a VolumeBackup. + #: This constant has a value of "FAULTY" + LIFECYCLE_STATE_FAULTY = "FAULTY" + + #: A constant which can be used with the lifecycle_state property of a VolumeBackup. + #: 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 VolumeBackup. + #: This constant has a value of "MANUAL" + SOURCE_TYPE_MANUAL = "MANUAL" + + #: A constant which can be used with the source_type property of a VolumeBackup. + #: This constant has a value of "SCHEDULED" + SOURCE_TYPE_SCHEDULED = "SCHEDULED" + + #: A constant which can be used with the type property of a VolumeBackup. + #: This constant has a value of "FULL" + TYPE_FULL = "FULL" + + #: A constant which can be used with the type property of a VolumeBackup. + #: This constant has a value of "INCREMENTAL" + TYPE_INCREMENTAL = "INCREMENTAL" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/volume_backup_policy.py b/src/oci/core/models/volume_backup_policy.py index dc8acdf5f3..f8e02d6746 100644 --- a/src/oci/core/models/volume_backup_policy.py +++ b/src/oci/core/models/volume_backup_policy.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class VolumeBackupPolicy(object): + """ + A policy for automatically creating volume backups according to a recurring schedule. Has a set of one or more schedules that control when and how backups are created. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/volume_backup_policy_assignment.py b/src/oci/core/models/volume_backup_policy_assignment.py index aae1e8f32c..591a7f076a 100644 --- a/src/oci/core/models/volume_backup_policy_assignment.py +++ b/src/oci/core/models/volume_backup_policy_assignment.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class VolumeBackupPolicyAssignment(object): + """ + Specifies that a particular volume backup policy is assigned to an asset such as a volume. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/volume_backup_schedule.py b/src/oci/core/models/volume_backup_schedule.py index 276b3a2db7..179c67aacb 100644 --- a/src/oci/core/models/volume_backup_schedule.py +++ b/src/oci/core/models/volume_backup_schedule.py @@ -8,6 +8,37 @@ @init_model_state_from_kwargs class VolumeBackupSchedule(object): + """ + Defines a chronological recurrence pattern for creating scheduled backups at a particular periodicity. + """ + + #: A constant which can be used with the backup_type property of a VolumeBackupSchedule. + #: This constant has a value of "FULL" + BACKUP_TYPE_FULL = "FULL" + + #: A constant which can be used with the backup_type property of a VolumeBackupSchedule. + #: This constant has a value of "INCREMENTAL" + BACKUP_TYPE_INCREMENTAL = "INCREMENTAL" + + #: A constant which can be used with the period property of a VolumeBackupSchedule. + #: This constant has a value of "ONE_HOUR" + PERIOD_ONE_HOUR = "ONE_HOUR" + + #: A constant which can be used with the period property of a VolumeBackupSchedule. + #: This constant has a value of "ONE_DAY" + PERIOD_ONE_DAY = "ONE_DAY" + + #: A constant which can be used with the period property of a VolumeBackupSchedule. + #: This constant has a value of "ONE_WEEK" + PERIOD_ONE_WEEK = "ONE_WEEK" + + #: A constant which can be used with the period property of a VolumeBackupSchedule. + #: This constant has a value of "ONE_MONTH" + PERIOD_ONE_MONTH = "ONE_MONTH" + + #: A constant which can be used with the period property of a VolumeBackupSchedule. + #: This constant has a value of "ONE_YEAR" + PERIOD_ONE_YEAR = "ONE_YEAR" def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/volume_source_details.py b/src/oci/core/models/volume_source_details.py index 698524bdba..0c6db5f99e 100644 --- a/src/oci/core/models/volume_source_details.py +++ b/src/oci/core/models/volume_source_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class VolumeSourceDetails(object): + """ + VolumeSourceDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/volume_source_from_volume_backup_details.py b/src/oci/core/models/volume_source_from_volume_backup_details.py index 6eb4b60594..cc39811ddf 100644 --- a/src/oci/core/models/volume_source_from_volume_backup_details.py +++ b/src/oci/core/models/volume_source_from_volume_backup_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class VolumeSourceFromVolumeBackupDetails(VolumeSourceDetails): + """ + Specifies the volume backup. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/models/volume_source_from_volume_details.py b/src/oci/core/models/volume_source_from_volume_details.py index d46e1d313e..fc1d1e3517 100644 --- a/src/oci/core/models/volume_source_from_volume_details.py +++ b/src/oci/core/models/volume_source_from_volume_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class VolumeSourceFromVolumeDetails(VolumeSourceDetails): + """ + Specifies the source volume. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/core/virtual_network_client.py b/src/oci/core/virtual_network_client.py index 846233ae29..c039f4538e 100644 --- a/src/oci/core/virtual_network_client.py +++ b/src/oci/core/virtual_network_client.py @@ -16,6 +16,9 @@ class VirtualNetworkClient(object): + """ + APIs for Networking Service, Compute Service, and Block Volume Service. + """ def __init__(self, config, **kwargs): validate_config(config, signer=kwargs.get('signer')) @@ -30,7 +33,14 @@ def __init__(self, config, **kwargs): pass_phrase=get_config_value_or_default(config, "pass_phrase"), private_key_content=config.get("key_content") ) - self.base_client = BaseClient("virtual_network", config, signer, core_type_mapping) + + base_client_init_kwargs = { + 'regional_client': True, + 'service_endpoint': kwargs.get('service_endpoint'), + 'timeout': kwargs.get('timeout'), + 'base_path': '/20160918' + } + self.base_client = BaseClient("virtual_network", config, signer, core_type_mapping, **base_client_init_kwargs) self.retry_strategy = kwargs.get('retry_strategy') def bulk_add_virtual_circuit_public_prefixes(self, virtual_circuit_id, bulk_add_virtual_circuit_public_prefixes_details, **kwargs): @@ -273,8 +283,12 @@ def connect_remote_peering_connections(self, remote_peering_connection_id, conne "content-type": "application/json" } + retry_strategy = self.retry_strategy if kwargs.get('retry_strategy'): - return kwargs['retry_strategy'].make_retrying_call( + 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, @@ -1179,10 +1193,14 @@ def create_remote_peering_connection(self, create_remote_peering_connection_deta } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing} + retry_strategy = self.retry_strategy if kwargs.get('retry_strategy'): - if not isinstance(kwargs['retry_strategy'], retry.NoneRetryStrategy): + 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 kwargs['retry_strategy'].make_retrying_call( + return retry_strategy.make_retrying_call( self.base_client.call_api, resource_path=resource_path, method=method, @@ -2453,8 +2471,12 @@ def delete_remote_peering_connection(self, remote_peering_connection_id, **kwarg } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing} + retry_strategy = self.retry_strategy if kwargs.get('retry_strategy'): - return kwargs['retry_strategy'].make_retrying_call( + 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, @@ -3865,8 +3887,12 @@ def get_remote_peering_connection(self, remote_peering_connection_id, **kwargs): "content-type": "application/json" } + retry_strategy = self.retry_strategy if kwargs.get('retry_strategy'): - return kwargs['retry_strategy'].make_retrying_call( + 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, @@ -4246,8 +4272,12 @@ def list_allowed_peer_regions_for_remote_peering(self, **kwargs): "content-type": "application/json" } + retry_strategy = self.retry_strategy if kwargs.get('retry_strategy'): - return kwargs['retry_strategy'].make_retrying_call( + 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, @@ -5651,8 +5681,12 @@ def list_remote_peering_connections(self, compartment_id, **kwargs): "content-type": "application/json" } + retry_strategy = self.retry_strategy if kwargs.get('retry_strategy'): - return kwargs['retry_strategy'].make_retrying_call( + 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, @@ -7335,8 +7369,12 @@ def update_remote_peering_connection(self, remote_peering_connection_id, update_ } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing} + retry_strategy = self.retry_strategy if kwargs.get('retry_strategy'): - return kwargs['retry_strategy'].make_retrying_call( + 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, diff --git a/src/oci/database/database_client.py b/src/oci/database/database_client.py index 4a0cb9c169..6f1f0cf4e8 100644 --- a/src/oci/database/database_client.py +++ b/src/oci/database/database_client.py @@ -16,6 +16,9 @@ class DatabaseClient(object): + """ + The API for the Database Service. + """ def __init__(self, config, **kwargs): validate_config(config, signer=kwargs.get('signer')) @@ -30,7 +33,14 @@ def __init__(self, config, **kwargs): pass_phrase=get_config_value_or_default(config, "pass_phrase"), private_key_content=config.get("key_content") ) - self.base_client = BaseClient("database", config, signer, database_type_mapping) + + base_client_init_kwargs = { + 'regional_client': True, + 'service_endpoint': kwargs.get('service_endpoint'), + 'timeout': kwargs.get('timeout'), + 'base_path': '/20160918' + } + self.base_client = BaseClient("database", config, signer, database_type_mapping, **base_client_init_kwargs) self.retry_strategy = kwargs.get('retry_strategy') def create_backup(self, create_backup_details, **kwargs): diff --git a/src/oci/database/models/backup.py b/src/oci/database/models/backup.py index 7c77120d45..423752e4f2 100644 --- a/src/oci/database/models/backup.py +++ b/src/oci/database/models/backup.py @@ -8,6 +8,44 @@ @init_model_state_from_kwargs class Backup(object): + """ + A database backup + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a Backup. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a Backup. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a Backup. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a Backup. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a Backup. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + #: A constant which can be used with the lifecycle_state property of a Backup. + #: This constant has a value of "RESTORING" + LIFECYCLE_STATE_RESTORING = "RESTORING" + + #: A constant which can be used with the type property of a Backup. + #: This constant has a value of "INCREMENTAL" + TYPE_INCREMENTAL = "INCREMENTAL" + + #: A constant which can be used with the type property of a Backup. + #: This constant has a value of "FULL" + TYPE_FULL = "FULL" def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/backup_summary.py b/src/oci/database/models/backup_summary.py index 2bf52505c8..11c0f2c871 100644 --- a/src/oci/database/models/backup_summary.py +++ b/src/oci/database/models/backup_summary.py @@ -8,6 +8,44 @@ @init_model_state_from_kwargs class BackupSummary(object): + """ + A database backup + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a BackupSummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a BackupSummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a BackupSummary. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a BackupSummary. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a BackupSummary. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + #: A constant which can be used with the lifecycle_state property of a BackupSummary. + #: This constant has a value of "RESTORING" + LIFECYCLE_STATE_RESTORING = "RESTORING" + + #: A constant which can be used with the type property of a BackupSummary. + #: This constant has a value of "INCREMENTAL" + TYPE_INCREMENTAL = "INCREMENTAL" + + #: A constant which can be used with the type property of a BackupSummary. + #: This constant has a value of "FULL" + TYPE_FULL = "FULL" def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/create_backup_details.py b/src/oci/database/models/create_backup_details.py index 26826556bd..6c9fd8869b 100644 --- a/src/oci/database/models/create_backup_details.py +++ b/src/oci/database/models/create_backup_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateBackupDetails(object): + """ + CreateBackupDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/create_data_guard_association_details.py b/src/oci/database/models/create_data_guard_association_details.py index d84d68e7df..93ae9de883 100644 --- a/src/oci/database/models/create_data_guard_association_details.py +++ b/src/oci/database/models/create_data_guard_association_details.py @@ -8,6 +8,40 @@ @init_model_state_from_kwargs class CreateDataGuardAssociationDetails(object): + """ + The configuration details for creating a Data Guard association between databases. + + **NOTE:** + \"ExistingDbSystem\" is the only supported `creationType` value. Therefore, all + :func:`create_data_guard_association` + requests must include the `peerDbSystemId` parameter found in the + :func:`create_data_guard_association_to_existing_db_system_details` + object. + """ + + #: A constant which can be used with the protection_mode property of a CreateDataGuardAssociationDetails. + #: This constant has a value of "MAXIMUM_AVAILABILITY" + PROTECTION_MODE_MAXIMUM_AVAILABILITY = "MAXIMUM_AVAILABILITY" + + #: A constant which can be used with the protection_mode property of a CreateDataGuardAssociationDetails. + #: This constant has a value of "MAXIMUM_PERFORMANCE" + PROTECTION_MODE_MAXIMUM_PERFORMANCE = "MAXIMUM_PERFORMANCE" + + #: A constant which can be used with the protection_mode property of a CreateDataGuardAssociationDetails. + #: This constant has a value of "MAXIMUM_PROTECTION" + PROTECTION_MODE_MAXIMUM_PROTECTION = "MAXIMUM_PROTECTION" + + #: A constant which can be used with the transport_type property of a CreateDataGuardAssociationDetails. + #: This constant has a value of "SYNC" + TRANSPORT_TYPE_SYNC = "SYNC" + + #: A constant which can be used with the transport_type property of a CreateDataGuardAssociationDetails. + #: This constant has a value of "ASYNC" + TRANSPORT_TYPE_ASYNC = "ASYNC" + + #: A constant which can be used with the transport_type property of a CreateDataGuardAssociationDetails. + #: This constant has a value of "FASTSYNC" + TRANSPORT_TYPE_FASTSYNC = "FASTSYNC" def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/create_data_guard_association_to_existing_db_system_details.py b/src/oci/database/models/create_data_guard_association_to_existing_db_system_details.py index e44a7542d8..594aca23e5 100644 --- a/src/oci/database/models/create_data_guard_association_to_existing_db_system_details.py +++ b/src/oci/database/models/create_data_guard_association_to_existing_db_system_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateDataGuardAssociationToExistingDbSystemDetails(CreateDataGuardAssociationDetails): + """ + The configuration details for creating a Data Guard association to an existing database. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/create_database_details.py b/src/oci/database/models/create_database_details.py index 933c8f49d9..954eeb2a84 100644 --- a/src/oci/database/models/create_database_details.py +++ b/src/oci/database/models/create_database_details.py @@ -8,6 +8,17 @@ @init_model_state_from_kwargs class CreateDatabaseDetails(object): + """ + CreateDatabaseDetails model. + """ + + #: A constant which can be used with the db_workload property of a CreateDatabaseDetails. + #: This constant has a value of "OLTP" + DB_WORKLOAD_OLTP = "OLTP" + + #: A constant which can be used with the db_workload property of a CreateDatabaseDetails. + #: This constant has a value of "DSS" + DB_WORKLOAD_DSS = "DSS" def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/create_database_from_backup_details.py b/src/oci/database/models/create_database_from_backup_details.py index d19ec067e7..31d01ad5df 100644 --- a/src/oci/database/models/create_database_from_backup_details.py +++ b/src/oci/database/models/create_database_from_backup_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateDatabaseFromBackupDetails(object): + """ + CreateDatabaseFromBackupDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/create_db_home_details.py b/src/oci/database/models/create_db_home_details.py index 9853800633..322d554b10 100644 --- a/src/oci/database/models/create_db_home_details.py +++ b/src/oci/database/models/create_db_home_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateDbHomeDetails(object): + """ + CreateDbHomeDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/create_db_home_with_db_system_id_base.py b/src/oci/database/models/create_db_home_with_db_system_id_base.py index 01a43b30a6..9b063e95cb 100644 --- a/src/oci/database/models/create_db_home_with_db_system_id_base.py +++ b/src/oci/database/models/create_db_home_with_db_system_id_base.py @@ -8,6 +8,17 @@ @init_model_state_from_kwargs class CreateDbHomeWithDbSystemIdBase(object): + """ + CreateDbHomeWithDbSystemIdBase model. + """ + + #: A constant which can be used with the source property of a CreateDbHomeWithDbSystemIdBase. + #: This constant has a value of "NONE" + SOURCE_NONE = "NONE" + + #: A constant which can be used with the source property of a CreateDbHomeWithDbSystemIdBase. + #: This constant has a value of "DB_BACKUP" + SOURCE_DB_BACKUP = "DB_BACKUP" def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/create_db_home_with_db_system_id_details.py b/src/oci/database/models/create_db_home_with_db_system_id_details.py index 00d833a3af..fa4792a181 100644 --- a/src/oci/database/models/create_db_home_with_db_system_id_details.py +++ b/src/oci/database/models/create_db_home_with_db_system_id_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateDbHomeWithDbSystemIdDetails(CreateDbHomeWithDbSystemIdBase): + """ + CreateDbHomeWithDbSystemIdDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/create_db_home_with_db_system_id_from_backup_details.py b/src/oci/database/models/create_db_home_with_db_system_id_from_backup_details.py index 2efcc7d7c5..adcc08cdfd 100644 --- a/src/oci/database/models/create_db_home_with_db_system_id_from_backup_details.py +++ b/src/oci/database/models/create_db_home_with_db_system_id_from_backup_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateDbHomeWithDbSystemIdFromBackupDetails(CreateDbHomeWithDbSystemIdBase): + """ + CreateDbHomeWithDbSystemIdFromBackupDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/data_guard_association.py b/src/oci/database/models/data_guard_association.py index 0de82ca58e..e2eae241fb 100644 --- a/src/oci/database/models/data_guard_association.py +++ b/src/oci/database/models/data_guard_association.py @@ -8,6 +8,93 @@ @init_model_state_from_kwargs class DataGuardAssociation(object): + """ + The properties that define a Data Guard association. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an + administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + For information about endpoints and signing API requests, see + `About the API`__. For information about available SDKs and tools, see + `SDKS and Other Tools`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/usingapi.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/sdks.htm + """ + + #: A constant which can be used with the lifecycle_state property of a DataGuardAssociation. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a DataGuardAssociation. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a DataGuardAssociation. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a DataGuardAssociation. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a DataGuardAssociation. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" + + #: A constant which can be used with the lifecycle_state property of a DataGuardAssociation. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + #: A constant which can be used with the peer_role property of a DataGuardAssociation. + #: This constant has a value of "PRIMARY" + PEER_ROLE_PRIMARY = "PRIMARY" + + #: A constant which can be used with the peer_role property of a DataGuardAssociation. + #: This constant has a value of "STANDBY" + PEER_ROLE_STANDBY = "STANDBY" + + #: A constant which can be used with the peer_role property of a DataGuardAssociation. + #: This constant has a value of "DISABLED_STANDBY" + PEER_ROLE_DISABLED_STANDBY = "DISABLED_STANDBY" + + #: A constant which can be used with the protection_mode property of a DataGuardAssociation. + #: This constant has a value of "MAXIMUM_AVAILABILITY" + PROTECTION_MODE_MAXIMUM_AVAILABILITY = "MAXIMUM_AVAILABILITY" + + #: A constant which can be used with the protection_mode property of a DataGuardAssociation. + #: This constant has a value of "MAXIMUM_PERFORMANCE" + PROTECTION_MODE_MAXIMUM_PERFORMANCE = "MAXIMUM_PERFORMANCE" + + #: A constant which can be used with the protection_mode property of a DataGuardAssociation. + #: This constant has a value of "MAXIMUM_PROTECTION" + PROTECTION_MODE_MAXIMUM_PROTECTION = "MAXIMUM_PROTECTION" + + #: A constant which can be used with the role property of a DataGuardAssociation. + #: This constant has a value of "PRIMARY" + ROLE_PRIMARY = "PRIMARY" + + #: A constant which can be used with the role property of a DataGuardAssociation. + #: This constant has a value of "STANDBY" + ROLE_STANDBY = "STANDBY" + + #: A constant which can be used with the role property of a DataGuardAssociation. + #: This constant has a value of "DISABLED_STANDBY" + ROLE_DISABLED_STANDBY = "DISABLED_STANDBY" + + #: A constant which can be used with the transport_type property of a DataGuardAssociation. + #: This constant has a value of "SYNC" + TRANSPORT_TYPE_SYNC = "SYNC" + + #: A constant which can be used with the transport_type property of a DataGuardAssociation. + #: This constant has a value of "ASYNC" + TRANSPORT_TYPE_ASYNC = "ASYNC" + + #: A constant which can be used with the transport_type property of a DataGuardAssociation. + #: This constant has a value of "FASTSYNC" + TRANSPORT_TYPE_FASTSYNC = "FASTSYNC" def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/data_guard_association_summary.py b/src/oci/database/models/data_guard_association_summary.py index 6be99836ee..ae70ababcb 100644 --- a/src/oci/database/models/data_guard_association_summary.py +++ b/src/oci/database/models/data_guard_association_summary.py @@ -8,6 +8,93 @@ @init_model_state_from_kwargs class DataGuardAssociationSummary(object): + """ + The properties that define a Data Guard association. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an + administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + For information about endpoints and signing API requests, see + `About the API`__. For information about available SDKs and tools, see + `SDKS and Other Tools`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/usingapi.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/sdks.htm + """ + + #: A constant which can be used with the lifecycle_state property of a DataGuardAssociationSummary. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a DataGuardAssociationSummary. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a DataGuardAssociationSummary. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a DataGuardAssociationSummary. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a DataGuardAssociationSummary. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" + + #: A constant which can be used with the lifecycle_state property of a DataGuardAssociationSummary. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + #: A constant which can be used with the peer_role property of a DataGuardAssociationSummary. + #: This constant has a value of "PRIMARY" + PEER_ROLE_PRIMARY = "PRIMARY" + + #: A constant which can be used with the peer_role property of a DataGuardAssociationSummary. + #: This constant has a value of "STANDBY" + PEER_ROLE_STANDBY = "STANDBY" + + #: A constant which can be used with the peer_role property of a DataGuardAssociationSummary. + #: This constant has a value of "DISABLED_STANDBY" + PEER_ROLE_DISABLED_STANDBY = "DISABLED_STANDBY" + + #: A constant which can be used with the protection_mode property of a DataGuardAssociationSummary. + #: This constant has a value of "MAXIMUM_AVAILABILITY" + PROTECTION_MODE_MAXIMUM_AVAILABILITY = "MAXIMUM_AVAILABILITY" + + #: A constant which can be used with the protection_mode property of a DataGuardAssociationSummary. + #: This constant has a value of "MAXIMUM_PERFORMANCE" + PROTECTION_MODE_MAXIMUM_PERFORMANCE = "MAXIMUM_PERFORMANCE" + + #: A constant which can be used with the protection_mode property of a DataGuardAssociationSummary. + #: This constant has a value of "MAXIMUM_PROTECTION" + PROTECTION_MODE_MAXIMUM_PROTECTION = "MAXIMUM_PROTECTION" + + #: A constant which can be used with the role property of a DataGuardAssociationSummary. + #: This constant has a value of "PRIMARY" + ROLE_PRIMARY = "PRIMARY" + + #: A constant which can be used with the role property of a DataGuardAssociationSummary. + #: This constant has a value of "STANDBY" + ROLE_STANDBY = "STANDBY" + + #: A constant which can be used with the role property of a DataGuardAssociationSummary. + #: This constant has a value of "DISABLED_STANDBY" + ROLE_DISABLED_STANDBY = "DISABLED_STANDBY" + + #: A constant which can be used with the transport_type property of a DataGuardAssociationSummary. + #: This constant has a value of "SYNC" + TRANSPORT_TYPE_SYNC = "SYNC" + + #: A constant which can be used with the transport_type property of a DataGuardAssociationSummary. + #: This constant has a value of "ASYNC" + TRANSPORT_TYPE_ASYNC = "ASYNC" + + #: A constant which can be used with the transport_type property of a DataGuardAssociationSummary. + #: This constant has a value of "FASTSYNC" + TRANSPORT_TYPE_FASTSYNC = "FASTSYNC" def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/database.py b/src/oci/database/models/database.py index af425004ee..92651b3e68 100644 --- a/src/oci/database/models/database.py +++ b/src/oci/database/models/database.py @@ -8,6 +8,46 @@ @init_model_state_from_kwargs class Database(object): + """ + An Oracle database on a DB System. For more information, see `Managing Oracle Databases`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Database/Concepts/overview.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a Database. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a Database. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a Database. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a Database. + #: This constant has a value of "BACKUP_IN_PROGRESS" + LIFECYCLE_STATE_BACKUP_IN_PROGRESS = "BACKUP_IN_PROGRESS" + + #: A constant which can be used with the lifecycle_state property of a Database. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a Database. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" + + #: A constant which can be used with the lifecycle_state property of a Database. + #: This constant has a value of "RESTORE_FAILED" + LIFECYCLE_STATE_RESTORE_FAILED = "RESTORE_FAILED" + + #: A constant which can be used with the lifecycle_state property of a Database. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/database_summary.py b/src/oci/database/models/database_summary.py index 04d311cfdf..72d5787003 100644 --- a/src/oci/database/models/database_summary.py +++ b/src/oci/database/models/database_summary.py @@ -8,6 +8,46 @@ @init_model_state_from_kwargs class DatabaseSummary(object): + """ + An Oracle database on a DB System. For more information, see `Managing Oracle Databases`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Database/Concepts/overview.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a DatabaseSummary. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a DatabaseSummary. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a DatabaseSummary. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a DatabaseSummary. + #: This constant has a value of "BACKUP_IN_PROGRESS" + LIFECYCLE_STATE_BACKUP_IN_PROGRESS = "BACKUP_IN_PROGRESS" + + #: A constant which can be used with the lifecycle_state property of a DatabaseSummary. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a DatabaseSummary. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" + + #: A constant which can be used with the lifecycle_state property of a DatabaseSummary. + #: This constant has a value of "RESTORE_FAILED" + LIFECYCLE_STATE_RESTORE_FAILED = "RESTORE_FAILED" + + #: A constant which can be used with the lifecycle_state property of a DatabaseSummary. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/db_backup_config.py b/src/oci/database/models/db_backup_config.py index 0eab2f6aff..4f20be90af 100644 --- a/src/oci/database/models/db_backup_config.py +++ b/src/oci/database/models/db_backup_config.py @@ -8,6 +8,12 @@ @init_model_state_from_kwargs class DbBackupConfig(object): + """ + Backup Options + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/db_home.py b/src/oci/database/models/db_home.py index 6a60d301d8..e3b08cdf90 100644 --- a/src/oci/database/models/db_home.py +++ b/src/oci/database/models/db_home.py @@ -8,6 +8,43 @@ @init_model_state_from_kwargs class DbHome(object): + """ + A directory where Oracle database software is installed. Each DB System can have multiple database homes, + and each database home can have multiple databases within it. All the databases within a single database home + must be the same database version, but different database homes can run different versions. For more information, + see `Managing Oracle Databases`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an + administrator. If you're an administrator who needs to write policies to give users access, + see `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Database/Concepts/overview.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a DbHome. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a DbHome. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a DbHome. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a DbHome. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a DbHome. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" + + #: A constant which can be used with the lifecycle_state property of a DbHome. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/db_home_summary.py b/src/oci/database/models/db_home_summary.py index 1faf09078b..25b01d9bab 100644 --- a/src/oci/database/models/db_home_summary.py +++ b/src/oci/database/models/db_home_summary.py @@ -8,6 +8,43 @@ @init_model_state_from_kwargs class DbHomeSummary(object): + """ + A directory where Oracle database software is installed. Each DB System can have multiple database homes, + and each database home can have multiple databases within it. All the databases within a single database home + must be the same database version, but different database homes can run different versions. For more information, + see `Managing Oracle Databases`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an + administrator. If you're an administrator who needs to write policies to give users access, + see `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Database/Concepts/overview.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a DbHomeSummary. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a DbHomeSummary. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a DbHomeSummary. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a DbHomeSummary. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a DbHomeSummary. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" + + #: A constant which can be used with the lifecycle_state property of a DbHomeSummary. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/db_node.py b/src/oci/database/models/db_node.py index b124ef470a..1943b15dfe 100644 --- a/src/oci/database/models/db_node.py +++ b/src/oci/database/models/db_node.py @@ -8,6 +8,49 @@ @init_model_state_from_kwargs class DbNode(object): + """ + A server where Oracle database software is running. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a DbNode. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a DbNode. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a DbNode. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a DbNode. + #: This constant has a value of "STOPPING" + LIFECYCLE_STATE_STOPPING = "STOPPING" + + #: A constant which can be used with the lifecycle_state property of a DbNode. + #: This constant has a value of "STOPPED" + LIFECYCLE_STATE_STOPPED = "STOPPED" + + #: A constant which can be used with the lifecycle_state property of a DbNode. + #: This constant has a value of "STARTING" + LIFECYCLE_STATE_STARTING = "STARTING" + + #: A constant which can be used with the lifecycle_state property of a DbNode. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a DbNode. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" + + #: A constant which can be used with the lifecycle_state property of a DbNode. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/db_node_summary.py b/src/oci/database/models/db_node_summary.py index 16f259734c..930289075b 100644 --- a/src/oci/database/models/db_node_summary.py +++ b/src/oci/database/models/db_node_summary.py @@ -8,6 +8,49 @@ @init_model_state_from_kwargs class DbNodeSummary(object): + """ + A server where Oracle database software is running. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a DbNodeSummary. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a DbNodeSummary. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a DbNodeSummary. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a DbNodeSummary. + #: This constant has a value of "STOPPING" + LIFECYCLE_STATE_STOPPING = "STOPPING" + + #: A constant which can be used with the lifecycle_state property of a DbNodeSummary. + #: This constant has a value of "STOPPED" + LIFECYCLE_STATE_STOPPED = "STOPPED" + + #: A constant which can be used with the lifecycle_state property of a DbNodeSummary. + #: This constant has a value of "STARTING" + LIFECYCLE_STATE_STARTING = "STARTING" + + #: A constant which can be used with the lifecycle_state property of a DbNodeSummary. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a DbNodeSummary. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" + + #: A constant which can be used with the lifecycle_state property of a DbNodeSummary. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/db_system.py b/src/oci/database/models/db_system.py index 0127c56f39..7a743dc07b 100644 --- a/src/oci/database/models/db_system.py +++ b/src/oci/database/models/db_system.py @@ -8,6 +8,85 @@ @init_model_state_from_kwargs class DbSystem(object): + """ + The Database Service supports several types of DB Systems, ranging in size, price, and performance. For details about each type of system, see: + + - `Exadata DB Systems`__ + - `Bare Metal and Virtual Machine DB Systems`__ + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + + For information about access control and compartments, see + `Overview of the Identity Service`__. + + For information about Availability Domains, see + `Regions and Availability Domains`__. + + To get a list of Availability Domains, use the `ListAvailabilityDomains` operation + in the Identity Service API. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Database/Concepts/exaoverview.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Database/Concepts/overview.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm + """ + + #: A constant which can be used with the database_edition property of a DbSystem. + #: This constant has a value of "STANDARD_EDITION" + DATABASE_EDITION_STANDARD_EDITION = "STANDARD_EDITION" + + #: A constant which can be used with the database_edition property of a DbSystem. + #: This constant has a value of "ENTERPRISE_EDITION" + DATABASE_EDITION_ENTERPRISE_EDITION = "ENTERPRISE_EDITION" + + #: A constant which can be used with the database_edition property of a DbSystem. + #: This constant has a value of "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" + DATABASE_EDITION_ENTERPRISE_EDITION_EXTREME_PERFORMANCE = "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" + + #: A constant which can be used with the database_edition property of a DbSystem. + #: This constant has a value of "ENTERPRISE_EDITION_HIGH_PERFORMANCE" + DATABASE_EDITION_ENTERPRISE_EDITION_HIGH_PERFORMANCE = "ENTERPRISE_EDITION_HIGH_PERFORMANCE" + + #: A constant which can be used with the disk_redundancy property of a DbSystem. + #: This constant has a value of "HIGH" + DISK_REDUNDANCY_HIGH = "HIGH" + + #: A constant which can be used with the disk_redundancy property of a DbSystem. + #: This constant has a value of "NORMAL" + DISK_REDUNDANCY_NORMAL = "NORMAL" + + #: A constant which can be used with the license_model property of a DbSystem. + #: This constant has a value of "LICENSE_INCLUDED" + LICENSE_MODEL_LICENSE_INCLUDED = "LICENSE_INCLUDED" + + #: A constant which can be used with the license_model property of a DbSystem. + #: This constant has a value of "BRING_YOUR_OWN_LICENSE" + LICENSE_MODEL_BRING_YOUR_OWN_LICENSE = "BRING_YOUR_OWN_LICENSE" + + #: A constant which can be used with the lifecycle_state property of a DbSystem. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a DbSystem. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a DbSystem. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a DbSystem. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a DbSystem. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" + + #: A constant which can be used with the lifecycle_state property of a DbSystem. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/db_system_shape_summary.py b/src/oci/database/models/db_system_shape_summary.py index c55688d848..9ea33f11bc 100644 --- a/src/oci/database/models/db_system_shape_summary.py +++ b/src/oci/database/models/db_system_shape_summary.py @@ -8,6 +8,16 @@ @init_model_state_from_kwargs class DbSystemShapeSummary(object): + """ + The shape of the DB System. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. + For a description of shapes, see `DB System Launch Options`__. + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. + If you're an administrator who needs to write policies to give users access, + see `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Database/References/launchoptions.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ 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 46fa1bbf56..6fb01fc4df 100644 --- a/src/oci/database/models/db_system_summary.py +++ b/src/oci/database/models/db_system_summary.py @@ -8,6 +8,85 @@ @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: + + - `Exadata DB Systems`__ + - `Bare Metal and Virtual Machine DB Systems`__ + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + + For information about access control and compartments, see + `Overview of the Identity Service`__. + + For information about Availability Domains, see + `Regions and Availability Domains`__. + + To get a list of Availability Domains, use the `ListAvailabilityDomains` operation + in the Identity Service API. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Database/Concepts/exaoverview.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Database/Concepts/overview.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm + """ + + #: A constant which can be used with the database_edition property of a DbSystemSummary. + #: This constant has a value of "STANDARD_EDITION" + DATABASE_EDITION_STANDARD_EDITION = "STANDARD_EDITION" + + #: A constant which can be used with the database_edition property of a DbSystemSummary. + #: This constant has a value of "ENTERPRISE_EDITION" + DATABASE_EDITION_ENTERPRISE_EDITION = "ENTERPRISE_EDITION" + + #: A constant which can be used with the database_edition property of a DbSystemSummary. + #: This constant has a value of "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" + DATABASE_EDITION_ENTERPRISE_EDITION_EXTREME_PERFORMANCE = "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" + + #: A constant which can be used with the database_edition property of a DbSystemSummary. + #: This constant has a value of "ENTERPRISE_EDITION_HIGH_PERFORMANCE" + DATABASE_EDITION_ENTERPRISE_EDITION_HIGH_PERFORMANCE = "ENTERPRISE_EDITION_HIGH_PERFORMANCE" + + #: A constant which can be used with the disk_redundancy property of a DbSystemSummary. + #: This constant has a value of "HIGH" + DISK_REDUNDANCY_HIGH = "HIGH" + + #: A constant which can be used with the disk_redundancy property of a DbSystemSummary. + #: This constant has a value of "NORMAL" + DISK_REDUNDANCY_NORMAL = "NORMAL" + + #: A constant which can be used with the license_model property of a DbSystemSummary. + #: This constant has a value of "LICENSE_INCLUDED" + LICENSE_MODEL_LICENSE_INCLUDED = "LICENSE_INCLUDED" + + #: A constant which can be used with the license_model property of a DbSystemSummary. + #: This constant has a value of "BRING_YOUR_OWN_LICENSE" + LICENSE_MODEL_BRING_YOUR_OWN_LICENSE = "BRING_YOUR_OWN_LICENSE" + + #: A constant which can be used with the lifecycle_state property of a DbSystemSummary. + #: This constant has a value of "PROVISIONING" + LIFECYCLE_STATE_PROVISIONING = "PROVISIONING" + + #: A constant which can be used with the lifecycle_state property of a DbSystemSummary. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a DbSystemSummary. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a DbSystemSummary. + #: This constant has a value of "TERMINATING" + LIFECYCLE_STATE_TERMINATING = "TERMINATING" + + #: A constant which can be used with the lifecycle_state property of a DbSystemSummary. + #: This constant has a value of "TERMINATED" + LIFECYCLE_STATE_TERMINATED = "TERMINATED" + + #: A constant which can be used with the lifecycle_state property of a DbSystemSummary. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/db_version_summary.py b/src/oci/database/models/db_version_summary.py index 3ffe54d932..0484596694 100644 --- a/src/oci/database/models/db_version_summary.py +++ b/src/oci/database/models/db_version_summary.py @@ -8,6 +8,13 @@ @init_model_state_from_kwargs class DbVersionSummary(object): + """ + The Oracle database software version. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/failover_data_guard_association_details.py b/src/oci/database/models/failover_data_guard_association_details.py index d255da4a85..947414c97f 100644 --- a/src/oci/database/models/failover_data_guard_association_details.py +++ b/src/oci/database/models/failover_data_guard_association_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class FailoverDataGuardAssociationDetails(object): + """ + The Data Guard association failover parameters. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/launch_db_system_details.py b/src/oci/database/models/launch_db_system_details.py index bd58e62da3..a59f35e1af 100644 --- a/src/oci/database/models/launch_db_system_details.py +++ b/src/oci/database/models/launch_db_system_details.py @@ -8,6 +8,41 @@ @init_model_state_from_kwargs class LaunchDbSystemDetails(object): + """ + LaunchDbSystemDetails model. + """ + + #: A constant which can be used with the database_edition property of a LaunchDbSystemDetails. + #: This constant has a value of "STANDARD_EDITION" + DATABASE_EDITION_STANDARD_EDITION = "STANDARD_EDITION" + + #: A constant which can be used with the database_edition property of a LaunchDbSystemDetails. + #: This constant has a value of "ENTERPRISE_EDITION" + DATABASE_EDITION_ENTERPRISE_EDITION = "ENTERPRISE_EDITION" + + #: A constant which can be used with the database_edition property of a LaunchDbSystemDetails. + #: This constant has a value of "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" + DATABASE_EDITION_ENTERPRISE_EDITION_EXTREME_PERFORMANCE = "ENTERPRISE_EDITION_EXTREME_PERFORMANCE" + + #: A constant which can be used with the database_edition property of a LaunchDbSystemDetails. + #: This constant has a value of "ENTERPRISE_EDITION_HIGH_PERFORMANCE" + DATABASE_EDITION_ENTERPRISE_EDITION_HIGH_PERFORMANCE = "ENTERPRISE_EDITION_HIGH_PERFORMANCE" + + #: A constant which can be used with the disk_redundancy property of a LaunchDbSystemDetails. + #: This constant has a value of "HIGH" + DISK_REDUNDANCY_HIGH = "HIGH" + + #: A constant which can be used with the disk_redundancy property of a LaunchDbSystemDetails. + #: This constant has a value of "NORMAL" + DISK_REDUNDANCY_NORMAL = "NORMAL" + + #: A constant which can be used with the license_model property of a LaunchDbSystemDetails. + #: This constant has a value of "LICENSE_INCLUDED" + LICENSE_MODEL_LICENSE_INCLUDED = "LICENSE_INCLUDED" + + #: A constant which can be used with the license_model property of a LaunchDbSystemDetails. + #: This constant has a value of "BRING_YOUR_OWN_LICENSE" + LICENSE_MODEL_BRING_YOUR_OWN_LICENSE = "BRING_YOUR_OWN_LICENSE" def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/patch.py b/src/oci/database/models/patch.py index 4e4069b8be..2eb16ceeab 100644 --- a/src/oci/database/models/patch.py +++ b/src/oci/database/models/patch.py @@ -8,6 +8,47 @@ @init_model_state_from_kwargs class Patch(object): + """ + A Patch for a DB System or DB Home. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the available_actions property of a Patch. + #: This constant has a value of "APPLY" + AVAILABLE_ACTIONS_APPLY = "APPLY" + + #: A constant which can be used with the available_actions property of a Patch. + #: This constant has a value of "PRECHECK" + AVAILABLE_ACTIONS_PRECHECK = "PRECHECK" + + #: A constant which can be used with the last_action property of a Patch. + #: This constant has a value of "APPLY" + LAST_ACTION_APPLY = "APPLY" + + #: A constant which can be used with the last_action property of a Patch. + #: This constant has a value of "PRECHECK" + LAST_ACTION_PRECHECK = "PRECHECK" + + #: A constant which can be used with the lifecycle_state property of a Patch. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a Patch. + #: This constant has a value of "SUCCESS" + LIFECYCLE_STATE_SUCCESS = "SUCCESS" + + #: A constant which can be used with the lifecycle_state property of a Patch. + #: This constant has a value of "IN_PROGRESS" + LIFECYCLE_STATE_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the lifecycle_state property of a Patch. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/patch_details.py b/src/oci/database/models/patch_details.py index a8818de324..eb5abfead1 100644 --- a/src/oci/database/models/patch_details.py +++ b/src/oci/database/models/patch_details.py @@ -8,6 +8,19 @@ @init_model_state_from_kwargs class PatchDetails(object): + """ + The details about what actions to perform and using what patch to the specified target. + This is part of an update request that is applied to a version field on the target such + as DB System, database home, etc. + """ + + #: A constant which can be used with the action property of a PatchDetails. + #: This constant has a value of "APPLY" + ACTION_APPLY = "APPLY" + + #: A constant which can be used with the action property of a PatchDetails. + #: This constant has a value of "PRECHECK" + ACTION_PRECHECK = "PRECHECK" def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/patch_history_entry.py b/src/oci/database/models/patch_history_entry.py index 03a0236ac5..47db624a43 100644 --- a/src/oci/database/models/patch_history_entry.py +++ b/src/oci/database/models/patch_history_entry.py @@ -8,6 +8,29 @@ @init_model_state_from_kwargs class PatchHistoryEntry(object): + """ + The record of a patch action on a specified target. + """ + + #: A constant which can be used with the action property of a PatchHistoryEntry. + #: This constant has a value of "APPLY" + ACTION_APPLY = "APPLY" + + #: A constant which can be used with the action property of a PatchHistoryEntry. + #: This constant has a value of "PRECHECK" + ACTION_PRECHECK = "PRECHECK" + + #: A constant which can be used with the lifecycle_state property of a PatchHistoryEntry. + #: This constant has a value of "IN_PROGRESS" + LIFECYCLE_STATE_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the lifecycle_state property of a PatchHistoryEntry. + #: This constant has a value of "SUCCEEDED" + LIFECYCLE_STATE_SUCCEEDED = "SUCCEEDED" + + #: A constant which can be used with the lifecycle_state property of a PatchHistoryEntry. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/patch_history_entry_summary.py b/src/oci/database/models/patch_history_entry_summary.py index 2a63af15ac..00a82bc022 100644 --- a/src/oci/database/models/patch_history_entry_summary.py +++ b/src/oci/database/models/patch_history_entry_summary.py @@ -8,6 +8,29 @@ @init_model_state_from_kwargs class PatchHistoryEntrySummary(object): + """ + The record of a patch action on a specified target. + """ + + #: A constant which can be used with the action property of a PatchHistoryEntrySummary. + #: This constant has a value of "APPLY" + ACTION_APPLY = "APPLY" + + #: A constant which can be used with the action property of a PatchHistoryEntrySummary. + #: This constant has a value of "PRECHECK" + ACTION_PRECHECK = "PRECHECK" + + #: A constant which can be used with the lifecycle_state property of a PatchHistoryEntrySummary. + #: This constant has a value of "IN_PROGRESS" + LIFECYCLE_STATE_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the lifecycle_state property of a PatchHistoryEntrySummary. + #: This constant has a value of "SUCCEEDED" + LIFECYCLE_STATE_SUCCEEDED = "SUCCEEDED" + + #: A constant which can be used with the lifecycle_state property of a PatchHistoryEntrySummary. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/patch_summary.py b/src/oci/database/models/patch_summary.py index 546b47ddeb..d636442166 100644 --- a/src/oci/database/models/patch_summary.py +++ b/src/oci/database/models/patch_summary.py @@ -8,6 +8,47 @@ @init_model_state_from_kwargs class PatchSummary(object): + """ + A Patch for a DB System or DB Home. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the available_actions property of a PatchSummary. + #: This constant has a value of "APPLY" + AVAILABLE_ACTIONS_APPLY = "APPLY" + + #: A constant which can be used with the available_actions property of a PatchSummary. + #: This constant has a value of "PRECHECK" + AVAILABLE_ACTIONS_PRECHECK = "PRECHECK" + + #: A constant which can be used with the last_action property of a PatchSummary. + #: This constant has a value of "APPLY" + LAST_ACTION_APPLY = "APPLY" + + #: A constant which can be used with the last_action property of a PatchSummary. + #: This constant has a value of "PRECHECK" + LAST_ACTION_PRECHECK = "PRECHECK" + + #: A constant which can be used with the lifecycle_state property of a PatchSummary. + #: This constant has a value of "AVAILABLE" + LIFECYCLE_STATE_AVAILABLE = "AVAILABLE" + + #: A constant which can be used with the lifecycle_state property of a PatchSummary. + #: This constant has a value of "SUCCESS" + LIFECYCLE_STATE_SUCCESS = "SUCCESS" + + #: A constant which can be used with the lifecycle_state property of a PatchSummary. + #: This constant has a value of "IN_PROGRESS" + LIFECYCLE_STATE_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the lifecycle_state property of a PatchSummary. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/reinstate_data_guard_association_details.py b/src/oci/database/models/reinstate_data_guard_association_details.py index f4993cbefa..ef562960b3 100644 --- a/src/oci/database/models/reinstate_data_guard_association_details.py +++ b/src/oci/database/models/reinstate_data_guard_association_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class ReinstateDataGuardAssociationDetails(object): + """ + The Data Guard association reinstate parameters. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/restore_database_details.py b/src/oci/database/models/restore_database_details.py index 3c5416f427..ed15410f57 100644 --- a/src/oci/database/models/restore_database_details.py +++ b/src/oci/database/models/restore_database_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class RestoreDatabaseDetails(object): + """ + RestoreDatabaseDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/switchover_data_guard_association_details.py b/src/oci/database/models/switchover_data_guard_association_details.py index e15076ba8b..3c87aad865 100644 --- a/src/oci/database/models/switchover_data_guard_association_details.py +++ b/src/oci/database/models/switchover_data_guard_association_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class SwitchoverDataGuardAssociationDetails(object): + """ + The Data Guard association switchover parameters. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/update_database_details.py b/src/oci/database/models/update_database_details.py index 4079781269..6f49f920c0 100644 --- a/src/oci/database/models/update_database_details.py +++ b/src/oci/database/models/update_database_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateDatabaseDetails(object): + """ + UpdateDatabaseDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/update_db_home_details.py b/src/oci/database/models/update_db_home_details.py index 000b51085c..77c28f0841 100644 --- a/src/oci/database/models/update_db_home_details.py +++ b/src/oci/database/models/update_db_home_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateDbHomeDetails(object): + """ + Describes the modification parameters for the DB Home. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/database/models/update_db_system_details.py b/src/oci/database/models/update_db_system_details.py index cc6cbef452..1c77704185 100644 --- a/src/oci/database/models/update_db_system_details.py +++ b/src/oci/database/models/update_db_system_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateDbSystemDetails(object): + """ + Describes the modification parameters for the DB System. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/dns/dns_client.py b/src/oci/dns/dns_client.py index 613bbfac82..a0ab65fd9f 100644 --- a/src/oci/dns/dns_client.py +++ b/src/oci/dns/dns_client.py @@ -16,6 +16,9 @@ class DnsClient(object): + """ + API for managing DNS zones, records, and policies. + """ def __init__(self, config, **kwargs): validate_config(config, signer=kwargs.get('signer')) @@ -30,7 +33,14 @@ def __init__(self, config, **kwargs): pass_phrase=get_config_value_or_default(config, "pass_phrase"), private_key_content=config.get("key_content") ) - self.base_client = BaseClient("dns", config, signer, dns_type_mapping) + + base_client_init_kwargs = { + 'regional_client': True, + 'service_endpoint': kwargs.get('service_endpoint'), + 'timeout': kwargs.get('timeout'), + 'base_path': '/20180115' + } + self.base_client = BaseClient("dns", config, signer, dns_type_mapping, **base_client_init_kwargs) self.retry_strategy = kwargs.get('retry_strategy') def create_zone(self, create_zone_details, **kwargs): diff --git a/src/oci/dns/models/create_zone_details.py b/src/oci/dns/models/create_zone_details.py index fbc938cca7..fee199ea6c 100644 --- a/src/oci/dns/models/create_zone_details.py +++ b/src/oci/dns/models/create_zone_details.py @@ -8,6 +8,17 @@ @init_model_state_from_kwargs class CreateZoneDetails(object): + """ + The body for defining a new zone. + """ + + #: A constant which can be used with the zone_type property of a CreateZoneDetails. + #: This constant has a value of "PRIMARY" + ZONE_TYPE_PRIMARY = "PRIMARY" + + #: A constant which can be used with the zone_type property of a CreateZoneDetails. + #: This constant has a value of "SECONDARY" + ZONE_TYPE_SECONDARY = "SECONDARY" def __init__(self, **kwargs): """ diff --git a/src/oci/dns/models/external_master.py b/src/oci/dns/models/external_master.py index ffa1820bcc..056ae33bdd 100644 --- a/src/oci/dns/models/external_master.py +++ b/src/oci/dns/models/external_master.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class ExternalMaster(object): + """ + An external master name server used as the source of zone data. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/dns/models/patch_domain_records_details.py b/src/oci/dns/models/patch_domain_records_details.py index 60171122d4..6c3b681e57 100644 --- a/src/oci/dns/models/patch_domain_records_details.py +++ b/src/oci/dns/models/patch_domain_records_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class PatchDomainRecordsDetails(object): + """ + PatchDomainRecordsDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/dns/models/patch_rr_set_details.py b/src/oci/dns/models/patch_rr_set_details.py index d4eac16d16..483234996e 100644 --- a/src/oci/dns/models/patch_rr_set_details.py +++ b/src/oci/dns/models/patch_rr_set_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class PatchRRSetDetails(object): + """ + PatchRRSetDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/dns/models/patch_zone_records_details.py b/src/oci/dns/models/patch_zone_records_details.py index b868485fc2..7cae7d1366 100644 --- a/src/oci/dns/models/patch_zone_records_details.py +++ b/src/oci/dns/models/patch_zone_records_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class PatchZoneRecordsDetails(object): + """ + PatchZoneRecordsDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/dns/models/record.py b/src/oci/dns/models/record.py index eb007f2b5a..4d3c1fb826 100644 --- a/src/oci/dns/models/record.py +++ b/src/oci/dns/models/record.py @@ -8,6 +8,11 @@ @init_model_state_from_kwargs class Record(object): + """ + A DNS resource record. For more information about DNS records, see `RFC 1034`__. + + __ https://tools.ietf.org/html/rfc1034#section-3.6 + """ def __init__(self, **kwargs): """ diff --git a/src/oci/dns/models/record_collection.py b/src/oci/dns/models/record_collection.py index e3d01d9c21..f323289b55 100644 --- a/src/oci/dns/models/record_collection.py +++ b/src/oci/dns/models/record_collection.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class RecordCollection(object): + """ + A collection of DNS resource records. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/dns/models/record_details.py b/src/oci/dns/models/record_details.py index 8410ba85ba..8787d5a84e 100644 --- a/src/oci/dns/models/record_details.py +++ b/src/oci/dns/models/record_details.py @@ -8,6 +8,11 @@ @init_model_state_from_kwargs class RecordDetails(object): + """ + A DNS resource record. For more information about records, see `RFC 1034`__. + + __ https://tools.ietf.org/html/rfc1034#section-3.6 + """ def __init__(self, **kwargs): """ diff --git a/src/oci/dns/models/record_operation.py b/src/oci/dns/models/record_operation.py index 08e0fc340b..6388dc5a2c 100644 --- a/src/oci/dns/models/record_operation.py +++ b/src/oci/dns/models/record_operation.py @@ -8,6 +8,27 @@ @init_model_state_from_kwargs class RecordOperation(object): + """ + An extension of the existing record resource, describing either a + precondition, an add, or a remove. Preconditions check all fields, + including read-only data like `recordHash` and `rrsetVersion`. + """ + + #: A constant which can be used with the operation property of a RecordOperation. + #: This constant has a value of "REQUIRE" + OPERATION_REQUIRE = "REQUIRE" + + #: A constant which can be used with the operation property of a RecordOperation. + #: This constant has a value of "PROHIBIT" + OPERATION_PROHIBIT = "PROHIBIT" + + #: A constant which can be used with the operation property of a RecordOperation. + #: This constant has a value of "ADD" + OPERATION_ADD = "ADD" + + #: A constant which can be used with the operation property of a RecordOperation. + #: This constant has a value of "REMOVE" + OPERATION_REMOVE = "REMOVE" def __init__(self, **kwargs): """ diff --git a/src/oci/dns/models/rr_set.py b/src/oci/dns/models/rr_set.py index 932bf90ccb..801dc4905f 100644 --- a/src/oci/dns/models/rr_set.py +++ b/src/oci/dns/models/rr_set.py @@ -8,6 +8,12 @@ @init_model_state_from_kwargs class RRSet(object): + """ + A collection of DNS records of the same domain and type. For more + information about record types, see `Resource Record (RR) TYPEs`__. + + __ https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4 + """ def __init__(self, **kwargs): """ diff --git a/src/oci/dns/models/tsig.py b/src/oci/dns/models/tsig.py index 7785e12237..07d32606b4 100644 --- a/src/oci/dns/models/tsig.py +++ b/src/oci/dns/models/tsig.py @@ -8,6 +8,11 @@ @init_model_state_from_kwargs class TSIG(object): + """ + A `TSIG`__ key. + + __ https://tools.ietf.org/html/rfc2845 + """ def __init__(self, **kwargs): """ diff --git a/src/oci/dns/models/update_domain_records_details.py b/src/oci/dns/models/update_domain_records_details.py index d013c89351..00b54ead66 100644 --- a/src/oci/dns/models/update_domain_records_details.py +++ b/src/oci/dns/models/update_domain_records_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateDomainRecordsDetails(object): + """ + UpdateDomainRecordsDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/dns/models/update_rr_set_details.py b/src/oci/dns/models/update_rr_set_details.py index 4939882b69..f1412163af 100644 --- a/src/oci/dns/models/update_rr_set_details.py +++ b/src/oci/dns/models/update_rr_set_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateRRSetDetails(object): + """ + UpdateRRSetDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/dns/models/update_zone_details.py b/src/oci/dns/models/update_zone_details.py index 0de95ee440..846eb92ecc 100644 --- a/src/oci/dns/models/update_zone_details.py +++ b/src/oci/dns/models/update_zone_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateZoneDetails(object): + """ + The body for updating a zone. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/dns/models/update_zone_records_details.py b/src/oci/dns/models/update_zone_records_details.py index 834b5fd357..1a4926a355 100644 --- a/src/oci/dns/models/update_zone_records_details.py +++ b/src/oci/dns/models/update_zone_records_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateZoneRecordsDetails(object): + """ + UpdateZoneRecordsDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/dns/models/zone.py b/src/oci/dns/models/zone.py index 55b3be7469..fbf2f669a9 100644 --- a/src/oci/dns/models/zone.py +++ b/src/oci/dns/models/zone.py @@ -8,6 +8,37 @@ @init_model_state_from_kwargs class Zone(object): + """ + A DNS zone. + """ + + #: A constant which can be used with the zone_type property of a Zone. + #: This constant has a value of "PRIMARY" + ZONE_TYPE_PRIMARY = "PRIMARY" + + #: A constant which can be used with the zone_type property of a Zone. + #: This constant has a value of "SECONDARY" + ZONE_TYPE_SECONDARY = "SECONDARY" + + #: A constant which can be used with the lifecycle_state property of a Zone. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a Zone. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a Zone. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a Zone. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a Zone. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" def __init__(self, **kwargs): """ diff --git a/src/oci/dns/models/zone_summary.py b/src/oci/dns/models/zone_summary.py index 3f068412f2..5cf5b820a7 100644 --- a/src/oci/dns/models/zone_summary.py +++ b/src/oci/dns/models/zone_summary.py @@ -8,6 +8,17 @@ @init_model_state_from_kwargs class ZoneSummary(object): + """ + A DNS zone. + """ + + #: A constant which can be used with the zone_type property of a ZoneSummary. + #: This constant has a value of "PRIMARY" + ZONE_TYPE_PRIMARY = "PRIMARY" + + #: A constant which can be used with the zone_type property of a ZoneSummary. + #: This constant has a value of "SECONDARY" + ZONE_TYPE_SECONDARY = "SECONDARY" def __init__(self, **kwargs): """ diff --git a/src/oci/email/email_client.py b/src/oci/email/email_client.py index b37c6148bd..6e2d07a796 100644 --- a/src/oci/email/email_client.py +++ b/src/oci/email/email_client.py @@ -16,6 +16,9 @@ class EmailClient(object): + """ + API spec for managing OCI Email Delivery services. + """ def __init__(self, config, **kwargs): validate_config(config, signer=kwargs.get('signer')) @@ -30,7 +33,14 @@ def __init__(self, config, **kwargs): pass_phrase=get_config_value_or_default(config, "pass_phrase"), private_key_content=config.get("key_content") ) - self.base_client = BaseClient("email", config, signer, email_type_mapping) + + base_client_init_kwargs = { + 'regional_client': True, + 'service_endpoint': kwargs.get('service_endpoint'), + 'timeout': kwargs.get('timeout'), + 'base_path': '/20170907' + } + self.base_client = BaseClient("email", config, signer, email_type_mapping, **base_client_init_kwargs) self.retry_strategy = kwargs.get('retry_strategy') def create_sender(self, create_sender_details, **kwargs): diff --git a/src/oci/email/models/create_sender_details.py b/src/oci/email/models/create_sender_details.py index 8d69d073f6..781aee04dd 100644 --- a/src/oci/email/models/create_sender_details.py +++ b/src/oci/email/models/create_sender_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateSenderDetails(object): + """ + The details needed for creating a sender. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/email/models/create_suppression_details.py b/src/oci/email/models/create_suppression_details.py index 3cdb10be7d..e90998406d 100644 --- a/src/oci/email/models/create_suppression_details.py +++ b/src/oci/email/models/create_suppression_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateSuppressionDetails(object): + """ + The details needed for creating a single suppression. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/email/models/sender.py b/src/oci/email/models/sender.py index 896ec36b35..6581e622c1 100644 --- a/src/oci/email/models/sender.py +++ b/src/oci/email/models/sender.py @@ -8,6 +8,25 @@ @init_model_state_from_kwargs class Sender(object): + """ + The full information representing an approved sender. + """ + + #: A constant which can be used with the lifecycle_state property of a Sender. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a Sender. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a Sender. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a Sender. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/email/models/sender_summary.py b/src/oci/email/models/sender_summary.py index fa5fa10d08..cf60917236 100644 --- a/src/oci/email/models/sender_summary.py +++ b/src/oci/email/models/sender_summary.py @@ -8,6 +8,25 @@ @init_model_state_from_kwargs class SenderSummary(object): + """ + The email addresses and `senderId` representing an approved sender. + """ + + #: A constant which can be used with the lifecycle_state property of a SenderSummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a SenderSummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a SenderSummary. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a SenderSummary. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/email/models/suppression.py b/src/oci/email/models/suppression.py index 2fe96ee877..c6673c3635 100644 --- a/src/oci/email/models/suppression.py +++ b/src/oci/email/models/suppression.py @@ -8,6 +8,33 @@ @init_model_state_from_kwargs class Suppression(object): + """ + The full information representing an email suppression. + """ + + #: A constant which can be used with the reason property of a Suppression. + #: This constant has a value of "UNKNOWN" + REASON_UNKNOWN = "UNKNOWN" + + #: A constant which can be used with the reason property of a Suppression. + #: This constant has a value of "HARDBOUNCE" + REASON_HARDBOUNCE = "HARDBOUNCE" + + #: A constant which can be used with the reason property of a Suppression. + #: This constant has a value of "COMPLAINT" + REASON_COMPLAINT = "COMPLAINT" + + #: A constant which can be used with the reason property of a Suppression. + #: This constant has a value of "MANUAL" + REASON_MANUAL = "MANUAL" + + #: A constant which can be used with the reason property of a Suppression. + #: This constant has a value of "SOFTBOUNCE" + REASON_SOFTBOUNCE = "SOFTBOUNCE" + + #: A constant which can be used with the reason property of a Suppression. + #: This constant has a value of "UNSUBSCRIBE" + REASON_UNSUBSCRIBE = "UNSUBSCRIBE" def __init__(self, **kwargs): """ diff --git a/src/oci/email/models/suppression_summary.py b/src/oci/email/models/suppression_summary.py index 24ebe243dd..9d8a934c81 100644 --- a/src/oci/email/models/suppression_summary.py +++ b/src/oci/email/models/suppression_summary.py @@ -8,6 +8,33 @@ @init_model_state_from_kwargs class SuppressionSummary(object): + """ + The full information representing a suppression. + """ + + #: A constant which can be used with the reason property of a SuppressionSummary. + #: This constant has a value of "UNKNOWN" + REASON_UNKNOWN = "UNKNOWN" + + #: A constant which can be used with the reason property of a SuppressionSummary. + #: This constant has a value of "HARDBOUNCE" + REASON_HARDBOUNCE = "HARDBOUNCE" + + #: A constant which can be used with the reason property of a SuppressionSummary. + #: This constant has a value of "COMPLAINT" + REASON_COMPLAINT = "COMPLAINT" + + #: A constant which can be used with the reason property of a SuppressionSummary. + #: This constant has a value of "MANUAL" + REASON_MANUAL = "MANUAL" + + #: A constant which can be used with the reason property of a SuppressionSummary. + #: This constant has a value of "SOFTBOUNCE" + REASON_SOFTBOUNCE = "SOFTBOUNCE" + + #: A constant which can be used with the reason property of a SuppressionSummary. + #: This constant has a value of "UNSUBSCRIBE" + REASON_UNSUBSCRIBE = "UNSUBSCRIBE" def __init__(self, **kwargs): """ diff --git a/src/oci/file_storage/file_storage_client.py b/src/oci/file_storage/file_storage_client.py index d0a18bf15b..f5067453e2 100644 --- a/src/oci/file_storage/file_storage_client.py +++ b/src/oci/file_storage/file_storage_client.py @@ -16,6 +16,10 @@ class FileStorageClient(object): + """ + The API for the File Storage Service. + + """ def __init__(self, config, **kwargs): validate_config(config, signer=kwargs.get('signer')) @@ -30,7 +34,14 @@ def __init__(self, config, **kwargs): pass_phrase=get_config_value_or_default(config, "pass_phrase"), private_key_content=config.get("key_content") ) - self.base_client = BaseClient("file_storage", config, signer, file_storage_type_mapping) + + base_client_init_kwargs = { + 'regional_client': True, + 'service_endpoint': kwargs.get('service_endpoint'), + 'timeout': kwargs.get('timeout'), + 'base_path': '/20171215' + } + self.base_client = BaseClient("file_storage", config, signer, file_storage_type_mapping, **base_client_init_kwargs) self.retry_strategy = kwargs.get('retry_strategy') def create_export(self, create_export_details, **kwargs): diff --git a/src/oci/file_storage/models/create_export_details.py b/src/oci/file_storage/models/create_export_details.py index 19b1bb4981..ed8e9a58c8 100644 --- a/src/oci/file_storage/models/create_export_details.py +++ b/src/oci/file_storage/models/create_export_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateExportDetails(object): + """ + CreateExportDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/file_storage/models/create_file_system_details.py b/src/oci/file_storage/models/create_file_system_details.py index 4c99b8b47c..b148d99b63 100644 --- a/src/oci/file_storage/models/create_file_system_details.py +++ b/src/oci/file_storage/models/create_file_system_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateFileSystemDetails(object): + """ + CreateFileSystemDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/file_storage/models/create_mount_target_details.py b/src/oci/file_storage/models/create_mount_target_details.py index 6697e4541e..0e1a0e9b2f 100644 --- a/src/oci/file_storage/models/create_mount_target_details.py +++ b/src/oci/file_storage/models/create_mount_target_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateMountTargetDetails(object): + """ + CreateMountTargetDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/file_storage/models/create_snapshot_details.py b/src/oci/file_storage/models/create_snapshot_details.py index 1a8f97cd8a..8e58e54818 100644 --- a/src/oci/file_storage/models/create_snapshot_details.py +++ b/src/oci/file_storage/models/create_snapshot_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateSnapshotDetails(object): + """ + CreateSnapshotDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/file_storage/models/export.py b/src/oci/file_storage/models/export.py index ae680ee3fe..9af7d88942 100644 --- a/src/oci/file_storage/models/export.py +++ b/src/oci/file_storage/models/export.py @@ -8,6 +8,53 @@ @init_model_state_from_kwargs class Export(object): + """ + A file system and the path that you can use to mount it. Each export + resource belongs to exactly one export set. + + The export's path attribute is not a path in the + referenced file system, but the value used by clients for the path + component of the remotetarget argument when mounting the file + system. + + The path must start with a slash (/) followed by a sequence of zero or more + slash-separated path elements. For any two export resources associated with + the same export set, except those in a 'DELETED' state, the path element + sequence for the first export resource can't contain the + complete path element sequence of the second export resource. + + For example, the following are acceptable: + + * /foo and /bar + * /foo1 and /foo2 + * /foo and /foo1 + + The following examples are not acceptable: + * /foo and /foo/bar + * / and /foo + + Paths may not end in a slash (/). No path element can be a period (.) + or two periods in sequence (..). All path elements must be 255 bytes or less. + + No two non-'DELETED' export resources in the same export set can + reference the same file system. + """ + + #: A constant which can be used with the lifecycle_state property of a Export. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a Export. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a Export. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a Export. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/file_storage/models/export_set.py b/src/oci/file_storage/models/export_set.py index 6b64fbf78c..c7b3850514 100644 --- a/src/oci/file_storage/models/export_set.py +++ b/src/oci/file_storage/models/export_set.py @@ -8,6 +8,26 @@ @init_model_state_from_kwargs class ExportSet(object): + """ + A set of file systems to export through one or more mount + targets. Composed of zero or more export resources. + """ + + #: A constant which can be used with the lifecycle_state property of a ExportSet. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a ExportSet. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a ExportSet. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a ExportSet. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/file_storage/models/export_set_summary.py b/src/oci/file_storage/models/export_set_summary.py index c40f2d52ea..153e70c62b 100644 --- a/src/oci/file_storage/models/export_set_summary.py +++ b/src/oci/file_storage/models/export_set_summary.py @@ -8,6 +8,25 @@ @init_model_state_from_kwargs class ExportSetSummary(object): + """ + Summary information for an export set. + """ + + #: A constant which can be used with the lifecycle_state property of a ExportSetSummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a ExportSetSummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a ExportSetSummary. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a ExportSetSummary. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/file_storage/models/export_summary.py b/src/oci/file_storage/models/export_summary.py index 6b02d03bc7..af3ab4451d 100644 --- a/src/oci/file_storage/models/export_summary.py +++ b/src/oci/file_storage/models/export_summary.py @@ -8,6 +8,25 @@ @init_model_state_from_kwargs class ExportSummary(object): + """ + Summary information for an export. + """ + + #: A constant which can be used with the lifecycle_state property of a ExportSummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a ExportSummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a ExportSummary. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a ExportSummary. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/file_storage/models/file_system.py b/src/oci/file_storage/models/file_system.py index 23c9609065..e7ab0d8fea 100644 --- a/src/oci/file_storage/models/file_system.py +++ b/src/oci/file_storage/models/file_system.py @@ -8,6 +8,36 @@ @init_model_state_from_kwargs class FileSystem(object): + """ + An NFS file system. To allow access to a file system, add it + to an export set and associate the export set with a mount + target. The same file system can be in multiple export sets and + associated with multiple mount targets. + + To use any of the API operations, you must be authorized in an + IAM policy. If you're not authorized, talk to an + administrator. If you're an administrator who needs to write + policies to give users access, see `Getting Started with + Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a FileSystem. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a FileSystem. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a FileSystem. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a FileSystem. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/file_storage/models/file_system_summary.py b/src/oci/file_storage/models/file_system_summary.py index c9bd763f6e..e77ab162b5 100644 --- a/src/oci/file_storage/models/file_system_summary.py +++ b/src/oci/file_storage/models/file_system_summary.py @@ -8,6 +8,25 @@ @init_model_state_from_kwargs class FileSystemSummary(object): + """ + Summary information for a file system. + """ + + #: A constant which can be used with the lifecycle_state property of a FileSystemSummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a FileSystemSummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a FileSystemSummary. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a FileSystemSummary. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/file_storage/models/mount_target.py b/src/oci/file_storage/models/mount_target.py index 505fb213cc..7e4a3d65ce 100644 --- a/src/oci/file_storage/models/mount_target.py +++ b/src/oci/file_storage/models/mount_target.py @@ -8,6 +8,31 @@ @init_model_state_from_kwargs class MountTarget(object): + """ + Provides access to a collection of file systems through one or more VNICs on a + specified subnet. The set of file systems is controlled through the + referenced export set. + """ + + #: A constant which can be used with the lifecycle_state property of a MountTarget. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a MountTarget. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a MountTarget. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a MountTarget. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a MountTarget. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" def __init__(self, **kwargs): """ diff --git a/src/oci/file_storage/models/mount_target_summary.py b/src/oci/file_storage/models/mount_target_summary.py index 083bce7d7f..f9c1c917ec 100644 --- a/src/oci/file_storage/models/mount_target_summary.py +++ b/src/oci/file_storage/models/mount_target_summary.py @@ -8,6 +8,29 @@ @init_model_state_from_kwargs class MountTargetSummary(object): + """ + Summary information for the specified mount target. + """ + + #: A constant which can be used with the lifecycle_state property of a MountTargetSummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a MountTargetSummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a MountTargetSummary. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a MountTargetSummary. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a MountTargetSummary. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" def __init__(self, **kwargs): """ diff --git a/src/oci/file_storage/models/snapshot.py b/src/oci/file_storage/models/snapshot.py index 83ef9834b3..7cbdbe313d 100644 --- a/src/oci/file_storage/models/snapshot.py +++ b/src/oci/file_storage/models/snapshot.py @@ -8,6 +8,25 @@ @init_model_state_from_kwargs class Snapshot(object): + """ + A point-in-time snapshot of a specified file system. + """ + + #: A constant which can be used with the lifecycle_state property of a Snapshot. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a Snapshot. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a Snapshot. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a Snapshot. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/file_storage/models/snapshot_summary.py b/src/oci/file_storage/models/snapshot_summary.py index ef93f21648..27b5f6dd77 100644 --- a/src/oci/file_storage/models/snapshot_summary.py +++ b/src/oci/file_storage/models/snapshot_summary.py @@ -8,6 +8,25 @@ @init_model_state_from_kwargs class SnapshotSummary(object): + """ + Summary information for a snapshot. + """ + + #: A constant which can be used with the lifecycle_state property of a SnapshotSummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a SnapshotSummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a SnapshotSummary. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a SnapshotSummary. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/file_storage/models/update_export_set_details.py b/src/oci/file_storage/models/update_export_set_details.py index fb78b70f59..b4cc2009e2 100644 --- a/src/oci/file_storage/models/update_export_set_details.py +++ b/src/oci/file_storage/models/update_export_set_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateExportSetDetails(object): + """ + UpdateExportSetDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/file_storage/models/update_file_system_details.py b/src/oci/file_storage/models/update_file_system_details.py index 5dd2a94c17..00ca87296b 100644 --- a/src/oci/file_storage/models/update_file_system_details.py +++ b/src/oci/file_storage/models/update_file_system_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateFileSystemDetails(object): + """ + UpdateFileSystemDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/file_storage/models/update_mount_target_details.py b/src/oci/file_storage/models/update_mount_target_details.py index 7f4c156549..cac7dc70bc 100644 --- a/src/oci/file_storage/models/update_mount_target_details.py +++ b/src/oci/file_storage/models/update_mount_target_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateMountTargetDetails(object): + """ + UpdateMountTargetDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/identity_client.py b/src/oci/identity/identity_client.py index 89b1aa69ad..47b04f9379 100644 --- a/src/oci/identity/identity_client.py +++ b/src/oci/identity/identity_client.py @@ -16,6 +16,9 @@ class IdentityClient(object): + """ + APIs for managing users, groups, compartments, and policies. + """ def __init__(self, config, **kwargs): validate_config(config, signer=kwargs.get('signer')) @@ -30,7 +33,14 @@ def __init__(self, config, **kwargs): pass_phrase=get_config_value_or_default(config, "pass_phrase"), private_key_content=config.get("key_content") ) - self.base_client = BaseClient("identity", config, signer, identity_type_mapping) + + base_client_init_kwargs = { + 'regional_client': True, + 'service_endpoint': kwargs.get('service_endpoint'), + 'timeout': kwargs.get('timeout'), + 'base_path': '/20160918' + } + self.base_client = BaseClient("identity", config, signer, identity_type_mapping, **base_client_init_kwargs) self.retry_strategy = kwargs.get('retry_strategy') def add_user_to_group(self, add_user_to_group_details, **kwargs): diff --git a/src/oci/identity/models/add_user_to_group_details.py b/src/oci/identity/models/add_user_to_group_details.py index 96f4c75fd1..9bc4ca5087 100644 --- a/src/oci/identity/models/add_user_to_group_details.py +++ b/src/oci/identity/models/add_user_to_group_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class AddUserToGroupDetails(object): + """ + AddUserToGroupDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/api_key.py b/src/oci/identity/models/api_key.py index 7a37c4301f..9d90db9ab2 100644 --- a/src/oci/identity/models/api_key.py +++ b/src/oci/identity/models/api_key.py @@ -8,6 +8,41 @@ @init_model_state_from_kwargs class ApiKey(object): + """ + A PEM-format RSA credential for securing requests to the Oracle Cloud Infrastructure REST API. Also known + as an *API signing key*. Specifically, this is the public key from the key pair. The private key remains with + the user calling the API. For information about generating a key pair + in the required PEM format, see `Required Keys and OCIDs`__. + + **Important:** This is **not** the SSH key for accessing compute instances. + + Each user can have a maximum of three API signing keys. + + For more information about user credentials, see `User Credentials`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/usercredentials.htm + """ + + #: A constant which can be used with the lifecycle_state property of a ApiKey. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a ApiKey. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a ApiKey. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the lifecycle_state property of a ApiKey. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a ApiKey. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/availability_domain.py b/src/oci/identity/models/availability_domain.py index aaaed62aee..75226b5845 100644 --- a/src/oci/identity/models/availability_domain.py +++ b/src/oci/identity/models/availability_domain.py @@ -8,6 +8,13 @@ @init_model_state_from_kwargs class AvailabilityDomain(object): + """ + One or more isolated, fault-tolerant Oracle data centers that host cloud resources such as instances, volumes, + and subnets. A region contains several Availability Domains. For more information, see + `Regions and Availability Domains`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/compartment.py b/src/oci/identity/models/compartment.py index 7780325250..20cb0e4023 100644 --- a/src/oci/identity/models/compartment.py +++ b/src/oci/identity/models/compartment.py @@ -8,6 +8,48 @@ @init_model_state_from_kwargs class Compartment(object): + """ + A collection of related resources. Compartments are a fundamental component of Oracle Cloud Infrastructure + for organizing and isolating your cloud resources. You use them to clearly separate resources for the purposes + of measuring usage and billing, access (through the use of IAM Service policies), and isolation (separating the + resources for one project or business unit from another). A common approach is to create a compartment for each + major part of your organization. For more information, see + `Overview of the IAM Service`__ and also + `Setting Up Your Tenancy`__. + + To place a resource in a compartment, simply specify the compartment ID in the \"Create\" request object when + initially creating the resource. For example, to launch an instance into a particular compartment, specify + that compartment's OCID in the `LaunchInstance` request. You can't move an existing resource from one + compartment to another. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/GSG/Concepts/settinguptenancy.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a Compartment. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a Compartment. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a Compartment. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the lifecycle_state property of a Compartment. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a Compartment. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/create_api_key_details.py b/src/oci/identity/models/create_api_key_details.py index 3fb3ae2c6e..dd3c7bca40 100644 --- a/src/oci/identity/models/create_api_key_details.py +++ b/src/oci/identity/models/create_api_key_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateApiKeyDetails(object): + """ + CreateApiKeyDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/create_compartment_details.py b/src/oci/identity/models/create_compartment_details.py index b591abe21c..54d25d8c7c 100644 --- a/src/oci/identity/models/create_compartment_details.py +++ b/src/oci/identity/models/create_compartment_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateCompartmentDetails(object): + """ + CreateCompartmentDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/create_customer_secret_key_details.py b/src/oci/identity/models/create_customer_secret_key_details.py index 564de35dfe..ea47de134b 100644 --- a/src/oci/identity/models/create_customer_secret_key_details.py +++ b/src/oci/identity/models/create_customer_secret_key_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateCustomerSecretKeyDetails(object): + """ + CreateCustomerSecretKeyDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/create_dynamic_group_details.py b/src/oci/identity/models/create_dynamic_group_details.py index 929fa35bb4..d96e372f5f 100644 --- a/src/oci/identity/models/create_dynamic_group_details.py +++ b/src/oci/identity/models/create_dynamic_group_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateDynamicGroupDetails(object): + """ + Properties for creating a dynamic group. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/create_group_details.py b/src/oci/identity/models/create_group_details.py index 2f562dc3a4..104569fbec 100644 --- a/src/oci/identity/models/create_group_details.py +++ b/src/oci/identity/models/create_group_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateGroupDetails(object): + """ + CreateGroupDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/create_identity_provider_details.py b/src/oci/identity/models/create_identity_provider_details.py index 330bbf243e..cd331168cb 100644 --- a/src/oci/identity/models/create_identity_provider_details.py +++ b/src/oci/identity/models/create_identity_provider_details.py @@ -8,6 +8,21 @@ @init_model_state_from_kwargs class CreateIdentityProviderDetails(object): + """ + CreateIdentityProviderDetails model. + """ + + #: A constant which can be used with the product_type property of a CreateIdentityProviderDetails. + #: This constant has a value of "IDCS" + PRODUCT_TYPE_IDCS = "IDCS" + + #: A constant which can be used with the product_type property of a CreateIdentityProviderDetails. + #: This constant has a value of "ADFS" + PRODUCT_TYPE_ADFS = "ADFS" + + #: A constant which can be used with the protocol property of a CreateIdentityProviderDetails. + #: This constant has a value of "SAML2" + PROTOCOL_SAML2 = "SAML2" def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/create_idp_group_mapping_details.py b/src/oci/identity/models/create_idp_group_mapping_details.py index 438c9aadb3..d67a8e34d6 100644 --- a/src/oci/identity/models/create_idp_group_mapping_details.py +++ b/src/oci/identity/models/create_idp_group_mapping_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateIdpGroupMappingDetails(object): + """ + CreateIdpGroupMappingDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/create_policy_details.py b/src/oci/identity/models/create_policy_details.py index 0d703d9fa2..c6a3c45f30 100644 --- a/src/oci/identity/models/create_policy_details.py +++ b/src/oci/identity/models/create_policy_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreatePolicyDetails(object): + """ + CreatePolicyDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/create_region_subscription_details.py b/src/oci/identity/models/create_region_subscription_details.py index 3d38e69f3e..75cd2775be 100644 --- a/src/oci/identity/models/create_region_subscription_details.py +++ b/src/oci/identity/models/create_region_subscription_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateRegionSubscriptionDetails(object): + """ + CreateRegionSubscriptionDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/create_saml2_identity_provider_details.py b/src/oci/identity/models/create_saml2_identity_provider_details.py index 558ddea9dd..33a5396098 100644 --- a/src/oci/identity/models/create_saml2_identity_provider_details.py +++ b/src/oci/identity/models/create_saml2_identity_provider_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateSaml2IdentityProviderDetails(CreateIdentityProviderDetails): + """ + CreateSaml2IdentityProviderDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/create_smtp_credential_details.py b/src/oci/identity/models/create_smtp_credential_details.py index fd7f2d2649..473360ac27 100644 --- a/src/oci/identity/models/create_smtp_credential_details.py +++ b/src/oci/identity/models/create_smtp_credential_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateSmtpCredentialDetails(object): + """ + CreateSmtpCredentialDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/create_swift_password_details.py b/src/oci/identity/models/create_swift_password_details.py index 36eff1aa32..e37a1ea366 100644 --- a/src/oci/identity/models/create_swift_password_details.py +++ b/src/oci/identity/models/create_swift_password_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateSwiftPasswordDetails(object): + """ + CreateSwiftPasswordDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/create_tag_details.py b/src/oci/identity/models/create_tag_details.py index b946e2e41b..1972575e7d 100644 --- a/src/oci/identity/models/create_tag_details.py +++ b/src/oci/identity/models/create_tag_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateTagDetails(object): + """ + CreateTagDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/create_tag_namespace_details.py b/src/oci/identity/models/create_tag_namespace_details.py index 349a5cd666..afaa7b9582 100644 --- a/src/oci/identity/models/create_tag_namespace_details.py +++ b/src/oci/identity/models/create_tag_namespace_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateTagNamespaceDetails(object): + """ + CreateTagNamespaceDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/create_user_details.py b/src/oci/identity/models/create_user_details.py index 0d9cdb55ee..c33c896b65 100644 --- a/src/oci/identity/models/create_user_details.py +++ b/src/oci/identity/models/create_user_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateUserDetails(object): + """ + CreateUserDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/customer_secret_key.py b/src/oci/identity/models/customer_secret_key.py index 9a70c8d546..c60b7603d9 100644 --- a/src/oci/identity/models/customer_secret_key.py +++ b/src/oci/identity/models/customer_secret_key.py @@ -8,6 +8,38 @@ @init_model_state_from_kwargs class CustomerSecretKey(object): + """ + A `CustomerSecretKey` is an Oracle-provided key for using the Object Storage Service's + `Amazon S3 compatible API`__. + A user can have up to two secret keys at a time. + + **Note:** The secret key is always an Oracle-generated string; you can't change it to a string of your choice. + + For more information, see `Managing User Credentials`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Object/Tasks/s3compatibleapi.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Tasks/managingcredentials.htm + """ + + #: A constant which can be used with the lifecycle_state property of a CustomerSecretKey. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a CustomerSecretKey. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a CustomerSecretKey. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the lifecycle_state property of a CustomerSecretKey. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a CustomerSecretKey. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/customer_secret_key_summary.py b/src/oci/identity/models/customer_secret_key_summary.py index f22d2ebb99..becefaa4c8 100644 --- a/src/oci/identity/models/customer_secret_key_summary.py +++ b/src/oci/identity/models/customer_secret_key_summary.py @@ -8,6 +8,30 @@ @init_model_state_from_kwargs class CustomerSecretKeySummary(object): + """ + As the name suggests, a `CustomerSecretKeySummary` object contains information about a `CustomerSecretKey`. + A `CustomerSecretKey` is an Oracle-provided key for using the Object Storage Service's Amazon S3 compatible API. + """ + + #: A constant which can be used with the lifecycle_state property of a CustomerSecretKeySummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a CustomerSecretKeySummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a CustomerSecretKeySummary. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the lifecycle_state property of a CustomerSecretKeySummary. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a CustomerSecretKeySummary. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/dynamic_group.py b/src/oci/identity/models/dynamic_group.py index 67bc0847f6..279569d2ed 100644 --- a/src/oci/identity/models/dynamic_group.py +++ b/src/oci/identity/models/dynamic_group.py @@ -8,6 +8,39 @@ @init_model_state_from_kwargs class DynamicGroup(object): + """ + A dynamic group defines a matching rule. Every bare metal or virtual machine instance is deployed with an instance certificate. + The certificate contains metadata about the instance. This includes the instance OCID and the compartment OCID, along + with a few other optional properties. When an API call is made using this instance certificate as the authenticator, + the certificate can be matched to one or multiple dynamic groups. The instance can then get access to the API + based on the permissions granted in policies written for the dynamic groups. + + This works like regular user/group membership. But in that case, the membership is a static relationship, whereas + in a dynamic group, the membership of an instance certificate to a dynamic group is determined during runtime. + For more information, see `Managing Dynamic Groups`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Tasks/managingdynamicgroups.htm + """ + + #: A constant which can be used with the lifecycle_state property of a DynamicGroup. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a DynamicGroup. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a DynamicGroup. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the lifecycle_state property of a DynamicGroup. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a DynamicGroup. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/group.py b/src/oci/identity/models/group.py index 4dbfe34d7e..3524300d7e 100644 --- a/src/oci/identity/models/group.py +++ b/src/oci/identity/models/group.py @@ -8,6 +8,45 @@ @init_model_state_from_kwargs class Group(object): + """ + A collection of users who all need the same type of access to a particular set of resources or compartment. + For conceptual information about groups and other IAM Service components, see + `Overview of the IAM Service`__. + + If you're federating with an identity provider (IdP), you need to create mappings between the groups + defined in the IdP and groups you define in the IAM service. For more information, see + `Identity Providers and Federation`__. Also see + :class:`IdentityProvider` and + :class:`IdpGroupMapping`. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/federation.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a Group. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a Group. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a Group. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the lifecycle_state property of a Group. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a Group. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/identity_provider.py b/src/oci/identity/models/identity_provider.py index 3a58b2ed34..722ed0698d 100644 --- a/src/oci/identity/models/identity_provider.py +++ b/src/oci/identity/models/identity_provider.py @@ -8,6 +8,40 @@ @init_model_state_from_kwargs class IdentityProvider(object): + """ + The resulting base object when you add an identity provider to your tenancy. A + :class:`Saml2IdentityProvider` + is a specific type of `IdentityProvider` that supports the SAML 2.0 protocol. Each + `IdentityProvider` object has its own OCID. For more information, see + `Identity Providers and Federation`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/federation.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a IdentityProvider. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a IdentityProvider. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a IdentityProvider. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the lifecycle_state property of a IdentityProvider. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a IdentityProvider. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/idp_group_mapping.py b/src/oci/identity/models/idp_group_mapping.py index 9da2551865..6cf517d665 100644 --- a/src/oci/identity/models/idp_group_mapping.py +++ b/src/oci/identity/models/idp_group_mapping.py @@ -8,6 +8,41 @@ @init_model_state_from_kwargs class IdpGroupMapping(object): + """ + A mapping between a single group defined by the identity provider (IdP) you're federating with + and a single IAM Service :class:`Group` in Oracle Cloud Infrastructure. + For more information about group mappings and what they're for, see + `Identity Providers and Federation`__. + + A given IdP group can be mapped to zero, one, or multiple IAM Service groups, and vice versa. + But each `IdPGroupMapping` object is between only a single IdP group and IAM Service group. + Each `IdPGroupMapping` object has its own OCID. + + **Note:** Any users who are in more than 50 IdP groups cannot be authenticated to use the Oracle + Cloud Infrastructure Console. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/federation.htm + """ + + #: A constant which can be used with the lifecycle_state property of a IdpGroupMapping. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a IdpGroupMapping. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a IdpGroupMapping. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the lifecycle_state property of a IdpGroupMapping. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a IdpGroupMapping. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/policy.py b/src/oci/identity/models/policy.py index abeadc8e95..370537655f 100644 --- a/src/oci/identity/models/policy.py +++ b/src/oci/identity/models/policy.py @@ -8,6 +8,44 @@ @init_model_state_from_kwargs class Policy(object): + """ + A document that specifies the type of access a group has to the resources in a compartment. For information about + policies and other IAM Service components, see + `Overview of the IAM Service`__. If you're new to policies, see + `Getting Started with Policies`__. + + The word \"policy\" is used by people in different ways: + + * An individual statement written in the policy language + * A collection of statements in a single, named \"policy\" document (which has an Oracle Cloud ID (OCID) assigned to it) + * The overall body of policies your organization uses to control access to resources + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a Policy. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a Policy. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a Policy. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the lifecycle_state property of a Policy. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a Policy. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/region.py b/src/oci/identity/models/region.py index 0c823aec47..93d19c9e19 100644 --- a/src/oci/identity/models/region.py +++ b/src/oci/identity/models/region.py @@ -8,6 +8,18 @@ @init_model_state_from_kwargs class Region(object): + """ + A localized geographic area, such as Phoenix, AZ. Oracle Cloud Infrastructure is hosted in regions and Availability + Domains. A region is composed of several Availability Domains. An Availability Domain is one or more data centers + located within a region. For more information, see `Regions and Availability Domains`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/region_subscription.py b/src/oci/identity/models/region_subscription.py index 11d6de90f5..be582e9224 100644 --- a/src/oci/identity/models/region_subscription.py +++ b/src/oci/identity/models/region_subscription.py @@ -8,6 +8,25 @@ @init_model_state_from_kwargs class RegionSubscription(object): + """ + An object that represents your tenancy's access to a particular region (i.e., a subscription), the status of that + access, and whether that region is the home region. For more information, see `Managing Regions`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Tasks/managingregions.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the status property of a RegionSubscription. + #: This constant has a value of "READY" + STATUS_READY = "READY" + + #: A constant which can be used with the status property of a RegionSubscription. + #: This constant has a value of "IN_PROGRESS" + STATUS_IN_PROGRESS = "IN_PROGRESS" def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/saml2_identity_provider.py b/src/oci/identity/models/saml2_identity_provider.py index 0bb92e177d..b806f88271 100644 --- a/src/oci/identity/models/saml2_identity_provider.py +++ b/src/oci/identity/models/saml2_identity_provider.py @@ -8,6 +8,13 @@ @init_model_state_from_kwargs class Saml2IdentityProvider(IdentityProvider): + """ + A special type of :class:`IdentityProvider` that + supports the SAML 2.0 protocol. For more information, see + `Identity Providers and Federation`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/federation.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/smtp_credential.py b/src/oci/identity/models/smtp_credential.py index 713d8815d1..6aff9f68b4 100644 --- a/src/oci/identity/models/smtp_credential.py +++ b/src/oci/identity/models/smtp_credential.py @@ -8,6 +8,38 @@ @init_model_state_from_kwargs class SmtpCredential(object): + """ + Simple Mail Transfer Protocol (SMTP) credentials are needed to send email through Email Delivery. + The SMTP credentials are used for SMTP authentication with the service. The credentials never expire. + A user can have up to 2 SMTP credentials at a time. + + **Note:** The credential set is always an Oracle-generated SMTP user name and password pair; + you cannot designate the SMTP user name or the SMTP password. + + For more information, see `Managing User Credentials`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Tasks/managingcredentials.htm#SMTP + """ + + #: A constant which can be used with the lifecycle_state property of a SmtpCredential. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a SmtpCredential. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a SmtpCredential. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the lifecycle_state property of a SmtpCredential. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a SmtpCredential. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/smtp_credential_summary.py b/src/oci/identity/models/smtp_credential_summary.py index bedebfdac7..78168774b9 100644 --- a/src/oci/identity/models/smtp_credential_summary.py +++ b/src/oci/identity/models/smtp_credential_summary.py @@ -8,6 +8,33 @@ @init_model_state_from_kwargs class SmtpCredentialSummary(object): + """ + As the name suggests, an `SmtpCredentialSummary` object contains information about an `SmtpCredential`. + The SMTP credential is used for SMTP authentication with + the `Email Delivery Service`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Email/Concepts/overview.htm + """ + + #: A constant which can be used with the lifecycle_state property of a SmtpCredentialSummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a SmtpCredentialSummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a SmtpCredentialSummary. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the lifecycle_state property of a SmtpCredentialSummary. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a SmtpCredentialSummary. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/swift_password.py b/src/oci/identity/models/swift_password.py index c1fd463df7..54187e8edb 100644 --- a/src/oci/identity/models/swift_password.py +++ b/src/oci/identity/models/swift_password.py @@ -8,6 +8,37 @@ @init_model_state_from_kwargs class SwiftPassword(object): + """ + Swift is the OpenStack object storage service. A `SwiftPassword` is an Oracle-provided password for using a + Swift client with the Oracle Cloud Infrastructure Object Storage Service. This password is associated with + the user's Console login. Swift passwords never expire. A user can have up to two Swift passwords at a time. + + **Note:** The password is always an Oracle-generated string; you can't change it to a string of your choice. + + For more information, see `Managing User Credentials`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Tasks/managingcredentials.htm + """ + + #: A constant which can be used with the lifecycle_state property of a SwiftPassword. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a SwiftPassword. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a SwiftPassword. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the lifecycle_state property of a SwiftPassword. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a SwiftPassword. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/tag.py b/src/oci/identity/models/tag.py index 3145a8bddb..5e492cedc0 100644 --- a/src/oci/identity/models/tag.py +++ b/src/oci/identity/models/tag.py @@ -8,6 +8,13 @@ @init_model_state_from_kwargs class Tag(object): + """ + A tag definition that belongs to a specific tag namespace. \"Defined tags\" must be set up in your tenancy before + you can apply them to resources. + For more information, see `Managing Tags and Tag Namespaces`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/taggingoverview.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/tag_namespace.py b/src/oci/identity/models/tag_namespace.py index 39f8d0690b..b557d71195 100644 --- a/src/oci/identity/models/tag_namespace.py +++ b/src/oci/identity/models/tag_namespace.py @@ -8,6 +8,12 @@ @init_model_state_from_kwargs class TagNamespace(object): + """ + A managed container for defined tags. A tag namespace is unique in a tenancy. A tag namespace can't be deleted. + For more information, see `Managing Tags and Tag Namespaces`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/taggingoverview.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/tag_namespace_summary.py b/src/oci/identity/models/tag_namespace_summary.py index 952f3fa0db..0ef5846f75 100644 --- a/src/oci/identity/models/tag_namespace_summary.py +++ b/src/oci/identity/models/tag_namespace_summary.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class TagNamespaceSummary(object): + """ + A container for defined tags. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/tag_summary.py b/src/oci/identity/models/tag_summary.py index 6b926b49ee..05623e6259 100644 --- a/src/oci/identity/models/tag_summary.py +++ b/src/oci/identity/models/tag_summary.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class TagSummary(object): + """ + A tag definition that belongs to a specific tag namespace. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/tenancy.py b/src/oci/identity/models/tenancy.py index e6239cf0fe..5da79e4dfe 100644 --- a/src/oci/identity/models/tenancy.py +++ b/src/oci/identity/models/tenancy.py @@ -8,6 +8,18 @@ @init_model_state_from_kwargs class Tenancy(object): + """ + The root compartment that contains all of your organization's compartments and other + Oracle Cloud Infrastructure cloud resources. When you sign up for Oracle Cloud Infrastructure, + Oracle creates a tenancy for your company, which is a secure and isolated partition + where you can create, organize, and administer your cloud resources. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/ui_password.py b/src/oci/identity/models/ui_password.py index 9b5c54319c..99eab8fa84 100644 --- a/src/oci/identity/models/ui_password.py +++ b/src/oci/identity/models/ui_password.py @@ -8,6 +8,34 @@ @init_model_state_from_kwargs class UIPassword(object): + """ + A text password that enables a user to sign in to the Console, the user interface for interacting with Oracle + Cloud Infrastructure. + + For more information about user credentials, see `User Credentials`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/usercredentials.htm + """ + + #: A constant which can be used with the lifecycle_state property of a UIPassword. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a UIPassword. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a UIPassword. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the lifecycle_state property of a UIPassword. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a UIPassword. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/update_compartment_details.py b/src/oci/identity/models/update_compartment_details.py index 6405ead165..0471a37a51 100644 --- a/src/oci/identity/models/update_compartment_details.py +++ b/src/oci/identity/models/update_compartment_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateCompartmentDetails(object): + """ + UpdateCompartmentDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/update_customer_secret_key_details.py b/src/oci/identity/models/update_customer_secret_key_details.py index 2a0084a6e4..339a0e0b1e 100644 --- a/src/oci/identity/models/update_customer_secret_key_details.py +++ b/src/oci/identity/models/update_customer_secret_key_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateCustomerSecretKeyDetails(object): + """ + UpdateCustomerSecretKeyDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/update_dynamic_group_details.py b/src/oci/identity/models/update_dynamic_group_details.py index 6b1c4c0bfb..1677aa1614 100644 --- a/src/oci/identity/models/update_dynamic_group_details.py +++ b/src/oci/identity/models/update_dynamic_group_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateDynamicGroupDetails(object): + """ + Properties for updating a dynamic group. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/update_group_details.py b/src/oci/identity/models/update_group_details.py index 4c3ab0f2e2..b24f48c065 100644 --- a/src/oci/identity/models/update_group_details.py +++ b/src/oci/identity/models/update_group_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateGroupDetails(object): + """ + UpdateGroupDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/update_identity_provider_details.py b/src/oci/identity/models/update_identity_provider_details.py index 8140a9e29d..7c18f50bd7 100644 --- a/src/oci/identity/models/update_identity_provider_details.py +++ b/src/oci/identity/models/update_identity_provider_details.py @@ -8,6 +8,13 @@ @init_model_state_from_kwargs class UpdateIdentityProviderDetails(object): + """ + UpdateIdentityProviderDetails model. + """ + + #: A constant which can be used with the protocol property of a UpdateIdentityProviderDetails. + #: This constant has a value of "SAML2" + PROTOCOL_SAML2 = "SAML2" def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/update_idp_group_mapping_details.py b/src/oci/identity/models/update_idp_group_mapping_details.py index 917e55274a..b92077cde2 100644 --- a/src/oci/identity/models/update_idp_group_mapping_details.py +++ b/src/oci/identity/models/update_idp_group_mapping_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateIdpGroupMappingDetails(object): + """ + UpdateIdpGroupMappingDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/update_policy_details.py b/src/oci/identity/models/update_policy_details.py index a4ce9e5015..ee23f346af 100644 --- a/src/oci/identity/models/update_policy_details.py +++ b/src/oci/identity/models/update_policy_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdatePolicyDetails(object): + """ + UpdatePolicyDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/update_saml2_identity_provider_details.py b/src/oci/identity/models/update_saml2_identity_provider_details.py index 84963f7ed0..c5dbc3bb04 100644 --- a/src/oci/identity/models/update_saml2_identity_provider_details.py +++ b/src/oci/identity/models/update_saml2_identity_provider_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateSaml2IdentityProviderDetails(UpdateIdentityProviderDetails): + """ + UpdateSaml2IdentityProviderDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/update_smtp_credential_details.py b/src/oci/identity/models/update_smtp_credential_details.py index 61c6f7f9ab..65f48c3ccb 100644 --- a/src/oci/identity/models/update_smtp_credential_details.py +++ b/src/oci/identity/models/update_smtp_credential_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateSmtpCredentialDetails(object): + """ + UpdateSmtpCredentialDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/update_state_details.py b/src/oci/identity/models/update_state_details.py index 2722d80040..50e7c6272d 100644 --- a/src/oci/identity/models/update_state_details.py +++ b/src/oci/identity/models/update_state_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateStateDetails(object): + """ + UpdateStateDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/update_swift_password_details.py b/src/oci/identity/models/update_swift_password_details.py index 5fecf8269a..afdce68999 100644 --- a/src/oci/identity/models/update_swift_password_details.py +++ b/src/oci/identity/models/update_swift_password_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateSwiftPasswordDetails(object): + """ + UpdateSwiftPasswordDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/update_tag_details.py b/src/oci/identity/models/update_tag_details.py index f20663addf..91b273e810 100644 --- a/src/oci/identity/models/update_tag_details.py +++ b/src/oci/identity/models/update_tag_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateTagDetails(object): + """ + UpdateTagDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/update_tag_namespace_details.py b/src/oci/identity/models/update_tag_namespace_details.py index d20792d6cb..5dc80308aa 100644 --- a/src/oci/identity/models/update_tag_namespace_details.py +++ b/src/oci/identity/models/update_tag_namespace_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateTagNamespaceDetails(object): + """ + UpdateTagNamespaceDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/update_user_details.py b/src/oci/identity/models/update_user_details.py index 0e57a246b1..ce784bf2f3 100644 --- a/src/oci/identity/models/update_user_details.py +++ b/src/oci/identity/models/update_user_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateUserDetails(object): + """ + UpdateUserDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/user.py b/src/oci/identity/models/user.py index f38d03545a..2b69673afa 100644 --- a/src/oci/identity/models/user.py +++ b/src/oci/identity/models/user.py @@ -8,6 +8,49 @@ @init_model_state_from_kwargs class User(object): + """ + An individual employee or system that needs to manage or use your company's Oracle Cloud Infrastructure + resources. Users might need to launch instances, manage remote disks, work with your cloud network, etc. Users + have one or more IAM Service credentials (:class:`ApiKey`, + :class:`UIPassword`, and :class:`SwiftPassword`). + For more information, see `User Credentials`__). End users of your + application are not typically IAM Service users. For conceptual information about users and other IAM Service + components, see `Overview of the IAM Service`__. + + These users are created directly within the Oracle Cloud Infrastructure system, via the IAM service. + They are different from *federated users*, who authenticate themselves to the Oracle Cloud Infrastructure + Console via an identity provider. For more information, see + `Identity Providers and Federation`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/usercredentials.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/federation.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the lifecycle_state property of a User. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a User. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a User. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the lifecycle_state property of a User. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a User. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/identity/models/user_group_membership.py b/src/oci/identity/models/user_group_membership.py index 2d93ed9db8..7b8f7459a0 100644 --- a/src/oci/identity/models/user_group_membership.py +++ b/src/oci/identity/models/user_group_membership.py @@ -8,6 +8,30 @@ @init_model_state_from_kwargs class UserGroupMembership(object): + """ + An object that represents the membership of a user in a group. When you add a user to a group, the result is a + `UserGroupMembership` with its own OCID. To remove a user from a group, you delete the `UserGroupMembership` object. + """ + + #: A constant which can be used with the lifecycle_state property of a UserGroupMembership. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a UserGroupMembership. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a UserGroupMembership. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the lifecycle_state property of a UserGroupMembership. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a UserGroupMembership. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/load_balancer_client.py b/src/oci/load_balancer/load_balancer_client.py index ad50f4b574..bab7181c76 100644 --- a/src/oci/load_balancer/load_balancer_client.py +++ b/src/oci/load_balancer/load_balancer_client.py @@ -16,6 +16,9 @@ class LoadBalancerClient(object): + """ + API for the Load Balancing Service + """ def __init__(self, config, **kwargs): validate_config(config, signer=kwargs.get('signer')) @@ -30,7 +33,14 @@ def __init__(self, config, **kwargs): pass_phrase=get_config_value_or_default(config, "pass_phrase"), private_key_content=config.get("key_content") ) - self.base_client = BaseClient("load_balancer", config, signer, load_balancer_type_mapping) + + base_client_init_kwargs = { + 'regional_client': True, + 'service_endpoint': kwargs.get('service_endpoint'), + 'timeout': kwargs.get('timeout'), + 'base_path': '/20170115' + } + self.base_client = BaseClient("load_balancer", config, signer, load_balancer_type_mapping, **base_client_init_kwargs) self.retry_strategy = kwargs.get('retry_strategy') def create_backend(self, create_backend_details, load_balancer_id, backend_set_name, **kwargs): diff --git a/src/oci/load_balancer/models/backend.py b/src/oci/load_balancer/models/backend.py index 4b4ac4aa9f..0edcde5e0d 100644 --- a/src/oci/load_balancer/models/backend.py +++ b/src/oci/load_balancer/models/backend.py @@ -8,6 +8,12 @@ @init_model_state_from_kwargs class Backend(object): + """ + The configuration of a backend server that is a member of a load balancer backend set. + For more information, see `Managing Backend Servers`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managingbackendservers.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/backend_details.py b/src/oci/load_balancer/models/backend_details.py index 538eaac840..c1ed540a3a 100644 --- a/src/oci/load_balancer/models/backend_details.py +++ b/src/oci/load_balancer/models/backend_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class BackendDetails(object): + """ + The load balancing configuration details of a backend server. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/backend_health.py b/src/oci/load_balancer/models/backend_health.py index 4b7377e6a2..726cfdea4a 100644 --- a/src/oci/load_balancer/models/backend_health.py +++ b/src/oci/load_balancer/models/backend_health.py @@ -8,6 +8,25 @@ @init_model_state_from_kwargs class BackendHealth(object): + """ + The health status of the specified backend server as reported by the primary and standby load balancers. + """ + + #: A constant which can be used with the status property of a BackendHealth. + #: This constant has a value of "OK" + STATUS_OK = "OK" + + #: A constant which can be used with the status property of a BackendHealth. + #: This constant has a value of "WARNING" + STATUS_WARNING = "WARNING" + + #: A constant which can be used with the status property of a BackendHealth. + #: This constant has a value of "CRITICAL" + STATUS_CRITICAL = "CRITICAL" + + #: A constant which can be used with the status property of a BackendHealth. + #: This constant has a value of "UNKNOWN" + STATUS_UNKNOWN = "UNKNOWN" def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/backend_set.py b/src/oci/load_balancer/models/backend_set.py index e69218c181..b3325d281b 100644 --- a/src/oci/load_balancer/models/backend_set.py +++ b/src/oci/load_balancer/models/backend_set.py @@ -8,6 +8,13 @@ @init_model_state_from_kwargs class BackendSet(object): + """ + The configuration of a load balancer backend set. + For more information on backend set configuration, see + `Managing Backend Sets`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/tasks/managingbackendsets.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/backend_set_details.py b/src/oci/load_balancer/models/backend_set_details.py index e2ed497cb9..c059768f40 100644 --- a/src/oci/load_balancer/models/backend_set_details.py +++ b/src/oci/load_balancer/models/backend_set_details.py @@ -8,6 +8,13 @@ @init_model_state_from_kwargs class BackendSetDetails(object): + """ + The configuration details for a load balancer backend set. + For more information on backend set configuration, see + `Managing Backend Sets`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/tasks/managingbackendsets.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/backend_set_health.py b/src/oci/load_balancer/models/backend_set_health.py index f76e86c776..3b5a2852eb 100644 --- a/src/oci/load_balancer/models/backend_set_health.py +++ b/src/oci/load_balancer/models/backend_set_health.py @@ -8,6 +8,28 @@ @init_model_state_from_kwargs class BackendSetHealth(object): + """ + The health status details for a backend set. + + This object does not explicitly enumerate backend servers with a status of `OK`. However, they are included in the + `totalBackendCount` sum. + """ + + #: A constant which can be used with the status property of a BackendSetHealth. + #: This constant has a value of "OK" + STATUS_OK = "OK" + + #: A constant which can be used with the status property of a BackendSetHealth. + #: This constant has a value of "WARNING" + STATUS_WARNING = "WARNING" + + #: A constant which can be used with the status property of a BackendSetHealth. + #: This constant has a value of "CRITICAL" + STATUS_CRITICAL = "CRITICAL" + + #: A constant which can be used with the status property of a BackendSetHealth. + #: This constant has a value of "UNKNOWN" + STATUS_UNKNOWN = "UNKNOWN" def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/certificate.py b/src/oci/load_balancer/models/certificate.py index 0badd3039b..5db3fbd75d 100644 --- a/src/oci/load_balancer/models/certificate.py +++ b/src/oci/load_balancer/models/certificate.py @@ -8,6 +8,13 @@ @init_model_state_from_kwargs class Certificate(object): + """ + The configuration details of a listener certificate bundle. + For more information on SSL certficate configuration, see + `Managing SSL Certificates`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managingcertificates.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/certificate_details.py b/src/oci/load_balancer/models/certificate_details.py index 4197e8bfee..923a82700e 100644 --- a/src/oci/load_balancer/models/certificate_details.py +++ b/src/oci/load_balancer/models/certificate_details.py @@ -8,6 +8,13 @@ @init_model_state_from_kwargs class CertificateDetails(object): + """ + The configuration details for a listener certificate bundle. + For more information on SSL certficate configuration, see + `Managing SSL Certificates`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managingcertificates.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/connection_configuration.py b/src/oci/load_balancer/models/connection_configuration.py index a78efd699f..ee2c52d699 100644 --- a/src/oci/load_balancer/models/connection_configuration.py +++ b/src/oci/load_balancer/models/connection_configuration.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class ConnectionConfiguration(object): + """ + Configuration details for the connection between the client and backend servers. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/create_backend_details.py b/src/oci/load_balancer/models/create_backend_details.py index f25d9f5c61..1730ca609a 100644 --- a/src/oci/load_balancer/models/create_backend_details.py +++ b/src/oci/load_balancer/models/create_backend_details.py @@ -8,6 +8,13 @@ @init_model_state_from_kwargs class CreateBackendDetails(object): + """ + The configuration details for creating a backend server in a backend set. + For more information on backend server configuration, see + `Managing Backend Servers`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/tasks/managingbackendservers.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/create_backend_set_details.py b/src/oci/load_balancer/models/create_backend_set_details.py index 27dc0d3532..e90a0d9f31 100644 --- a/src/oci/load_balancer/models/create_backend_set_details.py +++ b/src/oci/load_balancer/models/create_backend_set_details.py @@ -8,6 +8,13 @@ @init_model_state_from_kwargs class CreateBackendSetDetails(object): + """ + The configuration details for creating a backend set in a load balancer. + For more information on backend set configuration, see + `Managing Backend Sets`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/tasks/managingbackendsets.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/create_certificate_details.py b/src/oci/load_balancer/models/create_certificate_details.py index f8c0f87b7a..e7371a7378 100644 --- a/src/oci/load_balancer/models/create_certificate_details.py +++ b/src/oci/load_balancer/models/create_certificate_details.py @@ -8,6 +8,13 @@ @init_model_state_from_kwargs class CreateCertificateDetails(object): + """ + The configuration details for adding a certificate bundle to a listener. + For more information on SSL certficate configuration, see + `Managing SSL Certificates`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managingcertificates.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/create_listener_details.py b/src/oci/load_balancer/models/create_listener_details.py index c1d088fc24..49a97bf6b6 100644 --- a/src/oci/load_balancer/models/create_listener_details.py +++ b/src/oci/load_balancer/models/create_listener_details.py @@ -8,6 +8,13 @@ @init_model_state_from_kwargs class CreateListenerDetails(object): + """ + The configuration details for adding a listener to a backend set. + For more information on listener configuration, see + `Managing Load Balancer Listeners`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/tasks/managinglisteners.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/create_load_balancer_details.py b/src/oci/load_balancer/models/create_load_balancer_details.py index 61c41e1ba6..f4eb41523a 100644 --- a/src/oci/load_balancer/models/create_load_balancer_details.py +++ b/src/oci/load_balancer/models/create_load_balancer_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreateLoadBalancerDetails(object): + """ + The configuration details for creating a load balancer. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/create_path_route_set_details.py b/src/oci/load_balancer/models/create_path_route_set_details.py index 362fbac5fd..90c4f128b2 100644 --- a/src/oci/load_balancer/models/create_path_route_set_details.py +++ b/src/oci/load_balancer/models/create_path_route_set_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class CreatePathRouteSetDetails(object): + """ + A named set of path route rules to add to the load balancer. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/health_check_result.py b/src/oci/load_balancer/models/health_check_result.py index 117defa090..f748868b8d 100644 --- a/src/oci/load_balancer/models/health_check_result.py +++ b/src/oci/load_balancer/models/health_check_result.py @@ -8,6 +8,41 @@ @init_model_state_from_kwargs class HealthCheckResult(object): + """ + Information about a single backend server health check result reported by a load balancer. + """ + + #: A constant which can be used with the health_check_status property of a HealthCheckResult. + #: This constant has a value of "OK" + HEALTH_CHECK_STATUS_OK = "OK" + + #: A constant which can be used with the health_check_status property of a HealthCheckResult. + #: This constant has a value of "INVALID_STATUS_CODE" + HEALTH_CHECK_STATUS_INVALID_STATUS_CODE = "INVALID_STATUS_CODE" + + #: A constant which can be used with the health_check_status property of a HealthCheckResult. + #: This constant has a value of "TIMED_OUT" + HEALTH_CHECK_STATUS_TIMED_OUT = "TIMED_OUT" + + #: A constant which can be used with the health_check_status property of a HealthCheckResult. + #: This constant has a value of "REGEX_MISMATCH" + HEALTH_CHECK_STATUS_REGEX_MISMATCH = "REGEX_MISMATCH" + + #: A constant which can be used with the health_check_status property of a HealthCheckResult. + #: This constant has a value of "CONNECT_FAILED" + HEALTH_CHECK_STATUS_CONNECT_FAILED = "CONNECT_FAILED" + + #: A constant which can be used with the health_check_status property of a HealthCheckResult. + #: This constant has a value of "IO_ERROR" + HEALTH_CHECK_STATUS_IO_ERROR = "IO_ERROR" + + #: A constant which can be used with the health_check_status property of a HealthCheckResult. + #: This constant has a value of "OFFLINE" + HEALTH_CHECK_STATUS_OFFLINE = "OFFLINE" + + #: A constant which can be used with the health_check_status property of a HealthCheckResult. + #: This constant has a value of "UNKNOWN" + HEALTH_CHECK_STATUS_UNKNOWN = "UNKNOWN" def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/health_checker.py b/src/oci/load_balancer/models/health_checker.py index 93dc235301..050cc0230e 100644 --- a/src/oci/load_balancer/models/health_checker.py +++ b/src/oci/load_balancer/models/health_checker.py @@ -8,6 +8,12 @@ @init_model_state_from_kwargs class HealthChecker(object): + """ + The health check policy configuration. + For more information, see `Editing Health Check Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/editinghealthcheck.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/health_checker_details.py b/src/oci/load_balancer/models/health_checker_details.py index 182c947206..b2830533b3 100644 --- a/src/oci/load_balancer/models/health_checker_details.py +++ b/src/oci/load_balancer/models/health_checker_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class HealthCheckerDetails(object): + """ + The health check policy's configuration details. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/ip_address.py b/src/oci/load_balancer/models/ip_address.py index 62739a1489..174a5d9713 100644 --- a/src/oci/load_balancer/models/ip_address.py +++ b/src/oci/load_balancer/models/ip_address.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class IpAddress(object): + """ + A load balancer IP address. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/listener.py b/src/oci/load_balancer/models/listener.py index 394e652953..6000cc06cd 100644 --- a/src/oci/load_balancer/models/listener.py +++ b/src/oci/load_balancer/models/listener.py @@ -8,6 +8,13 @@ @init_model_state_from_kwargs class Listener(object): + """ + The listener's configuration. + For more information on backend set configuration, see + `Managing Load Balancer Listeners`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/tasks/managinglisteners.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/listener_details.py b/src/oci/load_balancer/models/listener_details.py index 7672a8e24d..3ca237b6ce 100644 --- a/src/oci/load_balancer/models/listener_details.py +++ b/src/oci/load_balancer/models/listener_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class ListenerDetails(object): + """ + The listener's configuration details. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/load_balancer.py b/src/oci/load_balancer/models/load_balancer.py index 1124cdde60..ddc5b65187 100644 --- a/src/oci/load_balancer/models/load_balancer.py +++ b/src/oci/load_balancer/models/load_balancer.py @@ -8,6 +8,43 @@ @init_model_state_from_kwargs class LoadBalancer(object): + """ + The properties that define a load balancer. For more information, see + `Managing a Load Balancer`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + For information about endpoints and signing API requests, see + `About the API`__. For information about available SDKs and tools, see + `SDKS and Other Tools`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managingloadbalancer.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/usingapi.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/sdks.htm + """ + + #: A constant which can be used with the lifecycle_state property of a LoadBalancer. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a LoadBalancer. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + #: A constant which can be used with the lifecycle_state property of a LoadBalancer. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a LoadBalancer. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a LoadBalancer. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/load_balancer_health.py b/src/oci/load_balancer/models/load_balancer_health.py index ed2965cbf6..313293c6e0 100644 --- a/src/oci/load_balancer/models/load_balancer_health.py +++ b/src/oci/load_balancer/models/load_balancer_health.py @@ -8,6 +8,28 @@ @init_model_state_from_kwargs class LoadBalancerHealth(object): + """ + The health status details for the specified load balancer. + + This object does not explicitly enumerate backend sets with a status of `OK`. However, they are included in the + `totalBackendSetCount` sum. + """ + + #: A constant which can be used with the status property of a LoadBalancerHealth. + #: This constant has a value of "OK" + STATUS_OK = "OK" + + #: A constant which can be used with the status property of a LoadBalancerHealth. + #: This constant has a value of "WARNING" + STATUS_WARNING = "WARNING" + + #: A constant which can be used with the status property of a LoadBalancerHealth. + #: This constant has a value of "CRITICAL" + STATUS_CRITICAL = "CRITICAL" + + #: A constant which can be used with the status property of a LoadBalancerHealth. + #: This constant has a value of "UNKNOWN" + STATUS_UNKNOWN = "UNKNOWN" def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/load_balancer_health_summary.py b/src/oci/load_balancer/models/load_balancer_health_summary.py index 96fba21021..08d20426bc 100644 --- a/src/oci/load_balancer/models/load_balancer_health_summary.py +++ b/src/oci/load_balancer/models/load_balancer_health_summary.py @@ -8,6 +8,25 @@ @init_model_state_from_kwargs class LoadBalancerHealthSummary(object): + """ + A health status summary for the specified load balancer. + """ + + #: A constant which can be used with the status property of a LoadBalancerHealthSummary. + #: This constant has a value of "OK" + STATUS_OK = "OK" + + #: A constant which can be used with the status property of a LoadBalancerHealthSummary. + #: This constant has a value of "WARNING" + STATUS_WARNING = "WARNING" + + #: A constant which can be used with the status property of a LoadBalancerHealthSummary. + #: This constant has a value of "CRITICAL" + STATUS_CRITICAL = "CRITICAL" + + #: A constant which can be used with the status property of a LoadBalancerHealthSummary. + #: This constant has a value of "UNKNOWN" + STATUS_UNKNOWN = "UNKNOWN" def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/load_balancer_policy.py b/src/oci/load_balancer/models/load_balancer_policy.py index 76842c0993..ba0a5b8989 100644 --- a/src/oci/load_balancer/models/load_balancer_policy.py +++ b/src/oci/load_balancer/models/load_balancer_policy.py @@ -8,6 +8,13 @@ @init_model_state_from_kwargs class LoadBalancerPolicy(object): + """ + A policy that determines how traffic is distributed among backend servers. + For more information on load balancing policies, see + `How Load Balancing Policies Work`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Reference/lbpolicies.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/load_balancer_protocol.py b/src/oci/load_balancer/models/load_balancer_protocol.py index 9efa321b69..304f17bd3b 100644 --- a/src/oci/load_balancer/models/load_balancer_protocol.py +++ b/src/oci/load_balancer/models/load_balancer_protocol.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class LoadBalancerProtocol(object): + """ + The protocol that defines the type of traffic accepted by a listener. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/load_balancer_shape.py b/src/oci/load_balancer/models/load_balancer_shape.py index cab0318964..7b6b648125 100644 --- a/src/oci/load_balancer/models/load_balancer_shape.py +++ b/src/oci/load_balancer/models/load_balancer_shape.py @@ -8,6 +8,13 @@ @init_model_state_from_kwargs class LoadBalancerShape(object): + """ + A shape is a template that determines the total pre-provisioned bandwidth (ingress plus egress) for the + load balancer. + + Note that the pre-provisioned maximum capacity applies to aggregated connections, not to a single client + attempting to use the full bandwidth. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/path_match_type.py b/src/oci/load_balancer/models/path_match_type.py index 389ac34d5f..1e23234ad5 100644 --- a/src/oci/load_balancer/models/path_match_type.py +++ b/src/oci/load_balancer/models/path_match_type.py @@ -8,6 +8,25 @@ @init_model_state_from_kwargs class PathMatchType(object): + """ + The type of matching to apply to incoming URIs. + """ + + #: A constant which can be used with the match_type property of a PathMatchType. + #: This constant has a value of "EXACT_MATCH" + MATCH_TYPE_EXACT_MATCH = "EXACT_MATCH" + + #: A constant which can be used with the match_type property of a PathMatchType. + #: This constant has a value of "FORCE_LONGEST_PREFIX_MATCH" + MATCH_TYPE_FORCE_LONGEST_PREFIX_MATCH = "FORCE_LONGEST_PREFIX_MATCH" + + #: A constant which can be used with the match_type property of a PathMatchType. + #: This constant has a value of "PREFIX_MATCH" + MATCH_TYPE_PREFIX_MATCH = "PREFIX_MATCH" + + #: A constant which can be used with the match_type property of a PathMatchType. + #: This constant has a value of "SUFFIX_MATCH" + MATCH_TYPE_SUFFIX_MATCH = "SUFFIX_MATCH" def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/path_route.py b/src/oci/load_balancer/models/path_route.py index 9ea99a251a..511734f62d 100644 --- a/src/oci/load_balancer/models/path_route.py +++ b/src/oci/load_balancer/models/path_route.py @@ -8,6 +8,11 @@ @init_model_state_from_kwargs class PathRoute(object): + """ + A \"path route rule\" to evaluate an incoming URI path, and then route a matching request to the specified backend set. + + Path route rules apply only to HTTP and HTTPS requests. They have no effect on TCP requests. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/path_route_set.py b/src/oci/load_balancer/models/path_route_set.py index c4ca81b7dd..4c72dae398 100644 --- a/src/oci/load_balancer/models/path_route_set.py +++ b/src/oci/load_balancer/models/path_route_set.py @@ -8,6 +8,12 @@ @init_model_state_from_kwargs class PathRouteSet(object): + """ + A named set of path route rules. For more information, see + `Managing Request Routing`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managingrequest.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/path_route_set_details.py b/src/oci/load_balancer/models/path_route_set_details.py index fccaeef1e6..f687baf54b 100644 --- a/src/oci/load_balancer/models/path_route_set_details.py +++ b/src/oci/load_balancer/models/path_route_set_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class PathRouteSetDetails(object): + """ + A set of path route rules. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/session_persistence_configuration_details.py b/src/oci/load_balancer/models/session_persistence_configuration_details.py index 8760e65122..e24bc66a8d 100644 --- a/src/oci/load_balancer/models/session_persistence_configuration_details.py +++ b/src/oci/load_balancer/models/session_persistence_configuration_details.py @@ -8,6 +8,19 @@ @init_model_state_from_kwargs class SessionPersistenceConfigurationDetails(object): + """ + The configuration details for implementing session persistence. Session persistence enables the Load Balancing + Service to direct any number of requests that originate from a single logical client to a single backend web server. + For more information, see `Session Persistence`__. + + To disable session persistence on a running load balancer, use the + :func:`update_backend_set` operation and specify \"null\" for the + `SessionPersistenceConfigurationDetails` object. + + Example: `SessionPersistenceConfigurationDetails: null` + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Reference/sessionpersistence.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/ssl_configuration.py b/src/oci/load_balancer/models/ssl_configuration.py index bc980b48a1..a20471d1af 100644 --- a/src/oci/load_balancer/models/ssl_configuration.py +++ b/src/oci/load_balancer/models/ssl_configuration.py @@ -8,6 +8,11 @@ @init_model_state_from_kwargs class SSLConfiguration(object): + """ + A listener's SSL handling configuration. + + To use SSL, a listener must be associated with a :class:`Certificate`. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/ssl_configuration_details.py b/src/oci/load_balancer/models/ssl_configuration_details.py index 34b237290e..9da023c5b9 100644 --- a/src/oci/load_balancer/models/ssl_configuration_details.py +++ b/src/oci/load_balancer/models/ssl_configuration_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class SSLConfigurationDetails(object): + """ + The load balancer's SSL handling configuration details. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/update_backend_details.py b/src/oci/load_balancer/models/update_backend_details.py index 6b16ce90bb..61aa87782b 100644 --- a/src/oci/load_balancer/models/update_backend_details.py +++ b/src/oci/load_balancer/models/update_backend_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateBackendDetails(object): + """ + The configuration details for updating a backend server. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/update_backend_set_details.py b/src/oci/load_balancer/models/update_backend_set_details.py index ad42225c18..7ededfc40c 100644 --- a/src/oci/load_balancer/models/update_backend_set_details.py +++ b/src/oci/load_balancer/models/update_backend_set_details.py @@ -8,6 +8,13 @@ @init_model_state_from_kwargs class UpdateBackendSetDetails(object): + """ + The configuration details for updating a load balancer backend set. + For more information on backend set configuration, see + `Managing Backend Sets`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/tasks/managingbackendsets.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/update_health_checker_details.py b/src/oci/load_balancer/models/update_health_checker_details.py index a9b66cabb1..3b9ba84a99 100644 --- a/src/oci/load_balancer/models/update_health_checker_details.py +++ b/src/oci/load_balancer/models/update_health_checker_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateHealthCheckerDetails(object): + """ + The health checker's configuration details. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/update_listener_details.py b/src/oci/load_balancer/models/update_listener_details.py index faaefe16b6..4ccfd0d708 100644 --- a/src/oci/load_balancer/models/update_listener_details.py +++ b/src/oci/load_balancer/models/update_listener_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateListenerDetails(object): + """ + The configuration details for updating a listener. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/update_load_balancer_details.py b/src/oci/load_balancer/models/update_load_balancer_details.py index 99db90c32d..696c52389e 100644 --- a/src/oci/load_balancer/models/update_load_balancer_details.py +++ b/src/oci/load_balancer/models/update_load_balancer_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdateLoadBalancerDetails(object): + """ + Configuration details to update a load balancer. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/update_path_route_set_details.py b/src/oci/load_balancer/models/update_path_route_set_details.py index dc67ad4e3e..13c96d1a23 100644 --- a/src/oci/load_balancer/models/update_path_route_set_details.py +++ b/src/oci/load_balancer/models/update_path_route_set_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class UpdatePathRouteSetDetails(object): + """ + An updated set of path route rules that overwrites the existing set of rules. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/work_request.py b/src/oci/load_balancer/models/work_request.py index f679adf38b..b4c0e95f9c 100644 --- a/src/oci/load_balancer/models/work_request.py +++ b/src/oci/load_balancer/models/work_request.py @@ -8,6 +8,30 @@ @init_model_state_from_kwargs class WorkRequest(object): + """ + Many of the API requests you use to create and configure load balancing do not take effect immediately. + In these cases, the request spawns an asynchronous work flow to fulfill the request. WorkRequest objects provide visibility + for in-progress work flows. + For more information about work requests, see `Viewing the State of a Work Request`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/viewingworkrequest.htm + """ + + #: A constant which can be used with the lifecycle_state property of a WorkRequest. + #: This constant has a value of "ACCEPTED" + LIFECYCLE_STATE_ACCEPTED = "ACCEPTED" + + #: A constant which can be used with the lifecycle_state property of a WorkRequest. + #: This constant has a value of "IN_PROGRESS" + LIFECYCLE_STATE_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the lifecycle_state property of a WorkRequest. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + #: A constant which can be used with the lifecycle_state property of a WorkRequest. + #: This constant has a value of "SUCCEEDED" + LIFECYCLE_STATE_SUCCEEDED = "SUCCEEDED" def __init__(self, **kwargs): """ diff --git a/src/oci/load_balancer/models/work_request_error.py b/src/oci/load_balancer/models/work_request_error.py index bf555e26c3..fe1bcf03f8 100644 --- a/src/oci/load_balancer/models/work_request_error.py +++ b/src/oci/load_balancer/models/work_request_error.py @@ -8,6 +8,17 @@ @init_model_state_from_kwargs class WorkRequestError(object): + """ + An object returned in the event of a work request error. + """ + + #: A constant which can be used with the error_code property of a WorkRequestError. + #: This constant has a value of "BAD_INPUT" + ERROR_CODE_BAD_INPUT = "BAD_INPUT" + + #: A constant which can be used with the error_code property of a WorkRequestError. + #: This constant has a value of "INTERNAL_ERROR" + ERROR_CODE_INTERNAL_ERROR = "INTERNAL_ERROR" def __init__(self, **kwargs): """ diff --git a/src/oci/object_storage/models/bucket.py b/src/oci/object_storage/models/bucket.py index f7984c5475..87b84bfe52 100644 --- a/src/oci/object_storage/models/bucket.py +++ b/src/oci/object_storage/models/bucket.py @@ -8,6 +8,38 @@ @init_model_state_from_kwargs class Bucket(object): + """ + A bucket is a container for storing objects in a compartment within a namespace. A bucket is associated with a single compartment. + The compartment has policies that indicate what actions a user can perform on a bucket and all the objects in the bucket. For more + information, see `Managing Buckets`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Object/Tasks/managingbuckets.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the public_access_type property of a Bucket. + #: This constant has a value of "NoPublicAccess" + PUBLIC_ACCESS_TYPE_NO_PUBLIC_ACCESS = "NoPublicAccess" + + #: A constant which can be used with the public_access_type property of a Bucket. + #: This constant has a value of "ObjectRead" + PUBLIC_ACCESS_TYPE_OBJECT_READ = "ObjectRead" + + #: A constant which can be used with the public_access_type property of a Bucket. + #: This constant has a value of "ObjectReadWithoutList" + PUBLIC_ACCESS_TYPE_OBJECT_READ_WITHOUT_LIST = "ObjectReadWithoutList" + + #: A constant which can be used with the storage_tier property of a Bucket. + #: This constant has a value of "Standard" + STORAGE_TIER_STANDARD = "Standard" + + #: A constant which can be used with the storage_tier property of a Bucket. + #: This constant has a value of "Archive" + STORAGE_TIER_ARCHIVE = "Archive" def __init__(self, **kwargs): """ diff --git a/src/oci/object_storage/models/bucket_summary.py b/src/oci/object_storage/models/bucket_summary.py index 3836e9c60a..6c05fc73b2 100644 --- a/src/oci/object_storage/models/bucket_summary.py +++ b/src/oci/object_storage/models/bucket_summary.py @@ -8,6 +8,13 @@ @init_model_state_from_kwargs class BucketSummary(object): + """ + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/object_storage/models/commit_multipart_upload_details.py b/src/oci/object_storage/models/commit_multipart_upload_details.py index 4cd5598be6..90b30cc8c2 100644 --- a/src/oci/object_storage/models/commit_multipart_upload_details.py +++ b/src/oci/object_storage/models/commit_multipart_upload_details.py @@ -8,6 +8,13 @@ @init_model_state_from_kwargs class CommitMultipartUploadDetails(object): + """ + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/object_storage/models/commit_multipart_upload_part_details.py b/src/oci/object_storage/models/commit_multipart_upload_part_details.py index 6cf1594d8f..7245a80a61 100644 --- a/src/oci/object_storage/models/commit_multipart_upload_part_details.py +++ b/src/oci/object_storage/models/commit_multipart_upload_part_details.py @@ -8,6 +8,13 @@ @init_model_state_from_kwargs class CommitMultipartUploadPartDetails(object): + """ + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/object_storage/models/create_bucket_details.py b/src/oci/object_storage/models/create_bucket_details.py index d24c9429ba..88179df476 100644 --- a/src/oci/object_storage/models/create_bucket_details.py +++ b/src/oci/object_storage/models/create_bucket_details.py @@ -8,6 +8,33 @@ @init_model_state_from_kwargs class CreateBucketDetails(object): + """ + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the public_access_type property of a CreateBucketDetails. + #: This constant has a value of "NoPublicAccess" + PUBLIC_ACCESS_TYPE_NO_PUBLIC_ACCESS = "NoPublicAccess" + + #: A constant which can be used with the public_access_type property of a CreateBucketDetails. + #: This constant has a value of "ObjectRead" + PUBLIC_ACCESS_TYPE_OBJECT_READ = "ObjectRead" + + #: A constant which can be used with the public_access_type property of a CreateBucketDetails. + #: This constant has a value of "ObjectReadWithoutList" + PUBLIC_ACCESS_TYPE_OBJECT_READ_WITHOUT_LIST = "ObjectReadWithoutList" + + #: A constant which can be used with the storage_tier property of a CreateBucketDetails. + #: This constant has a value of "Standard" + STORAGE_TIER_STANDARD = "Standard" + + #: A constant which can be used with the storage_tier property of a CreateBucketDetails. + #: This constant has a value of "Archive" + STORAGE_TIER_ARCHIVE = "Archive" def __init__(self, **kwargs): """ diff --git a/src/oci/object_storage/models/create_multipart_upload_details.py b/src/oci/object_storage/models/create_multipart_upload_details.py index e8968041e8..427a35b9e5 100644 --- a/src/oci/object_storage/models/create_multipart_upload_details.py +++ b/src/oci/object_storage/models/create_multipart_upload_details.py @@ -8,6 +8,13 @@ @init_model_state_from_kwargs class CreateMultipartUploadDetails(object): + """ + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/object_storage/models/create_preauthenticated_request_details.py b/src/oci/object_storage/models/create_preauthenticated_request_details.py index c25d482bd7..7b48631404 100644 --- a/src/oci/object_storage/models/create_preauthenticated_request_details.py +++ b/src/oci/object_storage/models/create_preauthenticated_request_details.py @@ -8,6 +8,25 @@ @init_model_state_from_kwargs class CreatePreauthenticatedRequestDetails(object): + """ + CreatePreauthenticatedRequestDetails model. + """ + + #: A constant which can be used with the access_type property of a CreatePreauthenticatedRequestDetails. + #: This constant has a value of "ObjectRead" + ACCESS_TYPE_OBJECT_READ = "ObjectRead" + + #: A constant which can be used with the access_type property of a CreatePreauthenticatedRequestDetails. + #: This constant has a value of "ObjectWrite" + ACCESS_TYPE_OBJECT_WRITE = "ObjectWrite" + + #: A constant which can be used with the access_type property of a CreatePreauthenticatedRequestDetails. + #: This constant has a value of "ObjectReadWrite" + ACCESS_TYPE_OBJECT_READ_WRITE = "ObjectReadWrite" + + #: A constant which can be used with the access_type property of a CreatePreauthenticatedRequestDetails. + #: This constant has a value of "AnyObjectWrite" + ACCESS_TYPE_ANY_OBJECT_WRITE = "AnyObjectWrite" def __init__(self, **kwargs): """ diff --git a/src/oci/object_storage/models/list_objects.py b/src/oci/object_storage/models/list_objects.py index da4934a79c..8cb43a4b59 100644 --- a/src/oci/object_storage/models/list_objects.py +++ b/src/oci/object_storage/models/list_objects.py @@ -8,6 +8,13 @@ @init_model_state_from_kwargs class ListObjects(object): + """ + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/object_storage/models/multipart_upload.py b/src/oci/object_storage/models/multipart_upload.py index 5cefa729a3..b8aed196db 100644 --- a/src/oci/object_storage/models/multipart_upload.py +++ b/src/oci/object_storage/models/multipart_upload.py @@ -8,6 +8,20 @@ @init_model_state_from_kwargs class MultipartUpload(object): + """ + Multipart uploads provide efficient and resilient uploads, especially for large objects. Multipart uploads also accommodate + objects that are too large for a single upload operation. With multipart uploads, individual parts of an object can be + uploaded in parallel to reduce the amount of time you spend uploading. Multipart uploads can also minimize the impact + of network failures by letting you retry a failed part upload instead of requiring you to retry an entire object upload. + See `Managing Multipart Uploads`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Object/Tasks/managingmultipartuploads.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/object_storage/models/multipart_upload_part_summary.py b/src/oci/object_storage/models/multipart_upload_part_summary.py index 321b79015d..3fa2f70769 100644 --- a/src/oci/object_storage/models/multipart_upload_part_summary.py +++ b/src/oci/object_storage/models/multipart_upload_part_summary.py @@ -8,6 +8,14 @@ @init_model_state_from_kwargs class MultipartUploadPartSummary(object): + """ + Get summary information about multipart uploads. + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/object_storage/models/namespace_metadata.py b/src/oci/object_storage/models/namespace_metadata.py index 37cf12a153..b5c7834a90 100644 --- a/src/oci/object_storage/models/namespace_metadata.py +++ b/src/oci/object_storage/models/namespace_metadata.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class NamespaceMetadata(object): + """ + A NamespaceMetadta is a map for storing namespace and defaultS3CompartmentId, defaultSwiftCompartmentId. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/object_storage/models/object_summary.py b/src/oci/object_storage/models/object_summary.py index 356b6eb417..30212de700 100644 --- a/src/oci/object_storage/models/object_summary.py +++ b/src/oci/object_storage/models/object_summary.py @@ -8,6 +8,13 @@ @init_model_state_from_kwargs class ObjectSummary(object): + """ + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/object_storage/models/preauthenticated_request.py b/src/oci/object_storage/models/preauthenticated_request.py index d93f7891cc..2cdfd862bb 100644 --- a/src/oci/object_storage/models/preauthenticated_request.py +++ b/src/oci/object_storage/models/preauthenticated_request.py @@ -8,6 +8,33 @@ @init_model_state_from_kwargs class PreauthenticatedRequest(object): + """ + Pre-authenticated requests provide a way to let users access a bucket or an object without having their own credentials. + When you create a pre-authenticated request, a unique URL is generated. Users in your organization, partners, or third + parties can use this URL to access the targets identified in the pre-authenticated request. See `Managing Access to Buckets and Objects`__. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. + If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Object/Tasks/managingaccess.htm + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the access_type property of a PreauthenticatedRequest. + #: This constant has a value of "ObjectRead" + ACCESS_TYPE_OBJECT_READ = "ObjectRead" + + #: A constant which can be used with the access_type property of a PreauthenticatedRequest. + #: This constant has a value of "ObjectWrite" + ACCESS_TYPE_OBJECT_WRITE = "ObjectWrite" + + #: A constant which can be used with the access_type property of a PreauthenticatedRequest. + #: This constant has a value of "ObjectReadWrite" + ACCESS_TYPE_OBJECT_READ_WRITE = "ObjectReadWrite" + + #: A constant which can be used with the access_type property of a PreauthenticatedRequest. + #: This constant has a value of "AnyObjectWrite" + ACCESS_TYPE_ANY_OBJECT_WRITE = "AnyObjectWrite" def __init__(self, **kwargs): """ diff --git a/src/oci/object_storage/models/preauthenticated_request_summary.py b/src/oci/object_storage/models/preauthenticated_request_summary.py index 248b9d4437..167796235e 100644 --- a/src/oci/object_storage/models/preauthenticated_request_summary.py +++ b/src/oci/object_storage/models/preauthenticated_request_summary.py @@ -8,6 +8,25 @@ @init_model_state_from_kwargs class PreauthenticatedRequestSummary(object): + """ + Get summary information about pre-authenticated requests. + """ + + #: A constant which can be used with the access_type property of a PreauthenticatedRequestSummary. + #: This constant has a value of "ObjectRead" + ACCESS_TYPE_OBJECT_READ = "ObjectRead" + + #: A constant which can be used with the access_type property of a PreauthenticatedRequestSummary. + #: This constant has a value of "ObjectWrite" + ACCESS_TYPE_OBJECT_WRITE = "ObjectWrite" + + #: A constant which can be used with the access_type property of a PreauthenticatedRequestSummary. + #: This constant has a value of "ObjectReadWrite" + ACCESS_TYPE_OBJECT_READ_WRITE = "ObjectReadWrite" + + #: A constant which can be used with the access_type property of a PreauthenticatedRequestSummary. + #: This constant has a value of "AnyObjectWrite" + ACCESS_TYPE_ANY_OBJECT_WRITE = "AnyObjectWrite" def __init__(self, **kwargs): """ diff --git a/src/oci/object_storage/models/rename_object_details.py b/src/oci/object_storage/models/rename_object_details.py index a7f7d53ffc..b4ee067a3b 100644 --- a/src/oci/object_storage/models/rename_object_details.py +++ b/src/oci/object_storage/models/rename_object_details.py @@ -8,6 +8,13 @@ @init_model_state_from_kwargs class RenameObjectDetails(object): + """ + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ def __init__(self, **kwargs): """ diff --git a/src/oci/object_storage/models/restore_objects_details.py b/src/oci/object_storage/models/restore_objects_details.py index bc97bfb9b7..e033c893b8 100644 --- a/src/oci/object_storage/models/restore_objects_details.py +++ b/src/oci/object_storage/models/restore_objects_details.py @@ -8,6 +8,9 @@ @init_model_state_from_kwargs class RestoreObjectsDetails(object): + """ + RestoreObjectsDetails model. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/object_storage/models/update_bucket_details.py b/src/oci/object_storage/models/update_bucket_details.py index 94c019a793..c71089e539 100644 --- a/src/oci/object_storage/models/update_bucket_details.py +++ b/src/oci/object_storage/models/update_bucket_details.py @@ -8,6 +8,25 @@ @init_model_state_from_kwargs class UpdateBucketDetails(object): + """ + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + `Getting Started with Policies`__. + + __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm + """ + + #: A constant which can be used with the public_access_type property of a UpdateBucketDetails. + #: This constant has a value of "NoPublicAccess" + PUBLIC_ACCESS_TYPE_NO_PUBLIC_ACCESS = "NoPublicAccess" + + #: A constant which can be used with the public_access_type property of a UpdateBucketDetails. + #: This constant has a value of "ObjectRead" + PUBLIC_ACCESS_TYPE_OBJECT_READ = "ObjectRead" + + #: A constant which can be used with the public_access_type property of a UpdateBucketDetails. + #: This constant has a value of "ObjectReadWithoutList" + PUBLIC_ACCESS_TYPE_OBJECT_READ_WITHOUT_LIST = "ObjectReadWithoutList" def __init__(self, **kwargs): """ diff --git a/src/oci/object_storage/models/update_namespace_metadata_details.py b/src/oci/object_storage/models/update_namespace_metadata_details.py index 8604b038a2..02251f51b8 100644 --- a/src/oci/object_storage/models/update_namespace_metadata_details.py +++ b/src/oci/object_storage/models/update_namespace_metadata_details.py @@ -8,6 +8,10 @@ @init_model_state_from_kwargs class UpdateNamespaceMetadataDetails(object): + """ + An UpdateNamespaceMetadataDetails is used for update NamespaceMetadata. To be able to upate the NamespaceMetadata, a user + must have NAMESPACE_UPDATE permission. + """ def __init__(self, **kwargs): """ diff --git a/src/oci/object_storage/object_storage_client.py b/src/oci/object_storage/object_storage_client.py index f644b6abab..01c87e8521 100644 --- a/src/oci/object_storage/object_storage_client.py +++ b/src/oci/object_storage/object_storage_client.py @@ -16,6 +16,9 @@ class ObjectStorageClient(object): + """ + Common set of Object and Archive Storage APIs for managing buckets and objects. + """ def __init__(self, config, **kwargs): validate_config(config, signer=kwargs.get('signer')) @@ -30,7 +33,14 @@ def __init__(self, config, **kwargs): pass_phrase=get_config_value_or_default(config, "pass_phrase"), private_key_content=config.get("key_content") ) - self.base_client = BaseClient("object_storage", config, signer, object_storage_type_mapping) + + base_client_init_kwargs = { + 'regional_client': True, + 'service_endpoint': kwargs.get('service_endpoint'), + 'timeout': kwargs.get('timeout'), + 'base_path': '/' + } + self.base_client = BaseClient("object_storage", config, signer, object_storage_type_mapping, **base_client_init_kwargs) self.retry_strategy = kwargs.get('retry_strategy') def abort_multipart_upload(self, namespace_name, bucket_name, object_name, upload_id, **kwargs): @@ -1766,6 +1776,8 @@ def put_object(self, namespace_name, bucket_name, object_name, put_object_body, :param dict(str, str) opc_meta: (optional) Optional user-defined metadata key and value. + "opc-meta-" will be appended to each dict key before it is sent to the server. + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` """ diff --git a/src/oci/object_storage/transfer/upload_manager.py b/src/oci/object_storage/transfer/upload_manager.py index 7001404e5e..5705544f92 100644 --- a/src/oci/object_storage/transfer/upload_manager.py +++ b/src/oci/object_storage/transfer/upload_manager.py @@ -3,13 +3,16 @@ from __future__ import print_function import os -from .internal.multipart_object_assembler import MultipartObjectAssembler +import requests +from .internal.multipart_object_assembler import MultipartObjectAssembler, DEFAULT_PARALLEL_PROCESS_COUNT from .constants import DEFAULT_PART_SIZE, STREAMING_DEFAULT_PART_SIZE from .internal.file_read_callback_stream import FileReadCallbackStream from ...exceptions import MultipartUploadError class UploadManager: + REQUESTS_POOL_SIZE_FACTOR = 4 + def __init__(self, object_storage_client, **kwargs): """ UploadManager simplifies interaction with the Object Storage service by abstracting away the method used @@ -38,6 +41,8 @@ def __init__(self, object_storage_client, **kwargs): self.allow_parallel_uploads = kwargs['allow_parallel_uploads'] if 'allow_parallel_uploads' in kwargs else True self.parallel_process_count = kwargs['parallel_process_count'] if 'parallel_process_count' in kwargs else None + self._add_adapter_to_service_client() + def upload_stream(self, namespace_name, bucket_name, @@ -335,6 +340,30 @@ def _upload_singlepart(self, **kwargs) return response + def _add_adapter_to_service_client(self): + # No need to mount with a larger pool size if we are not running multiple threads + if not self.allow_parallel_uploads or not self.parallel_process_count: + return + + endpoint = self.object_storage_client.base_client.endpoint + mount_protocol = 'https://' + if endpoint.startswith('http://'): + mount_protocol = 'http://' + + parallel_processes = DEFAULT_PARALLEL_PROCESS_COUNT + if self.parallel_process_count is not None: + parallel_processes = self.parallel_process_count + + target_pool_size = self.REQUESTS_POOL_SIZE_FACTOR * parallel_processes + adapter = requests.adapters.HTTPAdapter(pool_maxsize=target_pool_size) + + if mount_protocol in self.object_storage_client.base_client.session.adapters: + # If someone has already mounted and it's large enough, don't mount over the top + if self.object_storage_client.base_client.session.adapters[mount_protocol]._pool_maxsize >= target_pool_size: + return + + self.object_storage_client.base_client.session.mount(mount_protocol, adapter) + @staticmethod def _use_multipart(content_length, part_size=DEFAULT_PART_SIZE): return part_size < content_length diff --git a/src/oci/version.py b/src/oci/version.py index 938cb74886..6e90932b75 100644 --- a/src/oci/version.py +++ b/src/oci/version.py @@ -1,4 +1,4 @@ # coding: utf-8 # Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved. -__version__ = "1.3.17" +__version__ = "1.3.18" diff --git a/tox.ini b/tox.ini index 363e88c543..abc725229f 100644 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,5 @@ [tox] -envlist = py27, py35, flake8 +envlist = py27, py35, py36, flake8 [testenv] passenv = PYTHON_TESTS_ADMIN_PASS_PHRASE OCI_PYSDK*