diff --git a/CHANGELOG.rst b/CHANGELOG.rst index ce7cec8bc9..f7bf880163 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -3,6 +3,29 @@ Change Log All notable changes to this project will be documented in this file. The format is based on `Keep a Changelog `_. +==================== +2.8.0 - 2019-12-17 +==================== + +Added +----- +* Support for the API Gateway service +* Support for the OS Management service +* Support for the Marketplace service +* Support for "default"-type vaults in the Key Management service +* Support for bringing your own keys in the Key Management service +* Support for cross-region backups of boot volumes in the Block Storage service +* Support for top-level TSIG keys in the DNS service +* Support for resizing virtual machine instances to different shapes in the Compute service +* Support for management configuration of cloud agents in the Compute service +* Support for launching node pools using image IDs in the Container Engine for Kubernetes service + +Breaking +-------- +* Removed support for v1 auth tokens in kubeconfig files in the `CreateClusterKubeconfigContentDetails` class of the Container Engine for Kubernetes service +* Removed the IDCS access token requirement on the delete deleteOceInstance operation in the Content and Experience service, which is why the `DeleteOceInstanceDetails` class was removed +* Set `compartment_id` as a required parameter in `list_stream_pools` for streaming service + ==================== 2.7.1 - 2019-12-10 ==================== diff --git a/docs/api/apigateway.rst b/docs/api/apigateway.rst new file mode 100644 index 0000000000..070c40b535 --- /dev/null +++ b/docs/api/apigateway.rst @@ -0,0 +1,64 @@ +Apigateway +========== + +.. autosummary:: + :toctree: apigateway/client + :nosignatures: + :template: autosummary/service_client.rst + + oci.apigateway.DeploymentClient + oci.apigateway.GatewayClient + oci.apigateway.WorkRequestsClient + oci.apigateway.DeploymentClientCompositeOperations + oci.apigateway.GatewayClientCompositeOperations + oci.apigateway.WorkRequestsClientCompositeOperations + +-------- + Models +-------- + +.. autosummary:: + :toctree: apigateway/models + :nosignatures: + :template: autosummary/model_class.rst + + oci.apigateway.models.AccessLogPolicy + oci.apigateway.models.AnonymousRouteAuthorizationPolicy + oci.apigateway.models.AnyOfRouteAuthorizationPolicy + oci.apigateway.models.ApiSpecification + oci.apigateway.models.ApiSpecificationLoggingPolicies + oci.apigateway.models.ApiSpecificationRequestPolicies + oci.apigateway.models.ApiSpecificationRoute + oci.apigateway.models.ApiSpecificationRouteBackend + oci.apigateway.models.ApiSpecificationRouteRequestPolicies + oci.apigateway.models.AuthenticationOnlyRouteAuthorizationPolicy + oci.apigateway.models.AuthenticationPolicy + oci.apigateway.models.ChangeDeploymentCompartmentDetails + oci.apigateway.models.ChangeGatewayCompartmentDetails + oci.apigateway.models.CorsPolicy + oci.apigateway.models.CreateDeploymentDetails + oci.apigateway.models.CreateGatewayDetails + oci.apigateway.models.CustomAuthenticationPolicy + oci.apigateway.models.Deployment + oci.apigateway.models.DeploymentCollection + oci.apigateway.models.DeploymentSummary + oci.apigateway.models.ExecutionLogPolicy + oci.apigateway.models.Gateway + oci.apigateway.models.GatewayCollection + oci.apigateway.models.GatewaySummary + oci.apigateway.models.HTTPBackend + oci.apigateway.models.HeaderFieldSpecification + oci.apigateway.models.OracleFunctionBackend + oci.apigateway.models.RateLimitingPolicy + oci.apigateway.models.RouteAuthorizationPolicy + oci.apigateway.models.StockResponseBackend + oci.apigateway.models.UpdateDeploymentDetails + oci.apigateway.models.UpdateGatewayDetails + oci.apigateway.models.WorkRequest + oci.apigateway.models.WorkRequestCollection + oci.apigateway.models.WorkRequestError + oci.apigateway.models.WorkRequestErrorCollection + oci.apigateway.models.WorkRequestLog + oci.apigateway.models.WorkRequestLogCollection + oci.apigateway.models.WorkRequestResource + oci.apigateway.models.WorkRequestSummary diff --git a/docs/api/apigateway/client/oci.apigateway.DeploymentClient.rst b/docs/api/apigateway/client/oci.apigateway.DeploymentClient.rst new file mode 100644 index 0000000000..6c7f1796f5 --- /dev/null +++ b/docs/api/apigateway/client/oci.apigateway.DeploymentClient.rst @@ -0,0 +1,8 @@ +DeploymentClient +================ + +.. currentmodule:: oci.apigateway + +.. autoclass:: DeploymentClient + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/apigateway/client/oci.apigateway.DeploymentClientCompositeOperations.rst b/docs/api/apigateway/client/oci.apigateway.DeploymentClientCompositeOperations.rst new file mode 100644 index 0000000000..505f0617e2 --- /dev/null +++ b/docs/api/apigateway/client/oci.apigateway.DeploymentClientCompositeOperations.rst @@ -0,0 +1,8 @@ +DeploymentClientCompositeOperations +=================================== + +.. currentmodule:: oci.apigateway + +.. autoclass:: DeploymentClientCompositeOperations + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/apigateway/client/oci.apigateway.GatewayClient.rst b/docs/api/apigateway/client/oci.apigateway.GatewayClient.rst new file mode 100644 index 0000000000..fceed180d0 --- /dev/null +++ b/docs/api/apigateway/client/oci.apigateway.GatewayClient.rst @@ -0,0 +1,8 @@ +GatewayClient +============= + +.. currentmodule:: oci.apigateway + +.. autoclass:: GatewayClient + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/apigateway/client/oci.apigateway.GatewayClientCompositeOperations.rst b/docs/api/apigateway/client/oci.apigateway.GatewayClientCompositeOperations.rst new file mode 100644 index 0000000000..614e8c742b --- /dev/null +++ b/docs/api/apigateway/client/oci.apigateway.GatewayClientCompositeOperations.rst @@ -0,0 +1,8 @@ +GatewayClientCompositeOperations +================================ + +.. currentmodule:: oci.apigateway + +.. autoclass:: GatewayClientCompositeOperations + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/apigateway/client/oci.apigateway.WorkRequestsClient.rst b/docs/api/apigateway/client/oci.apigateway.WorkRequestsClient.rst new file mode 100644 index 0000000000..5049a46a2d --- /dev/null +++ b/docs/api/apigateway/client/oci.apigateway.WorkRequestsClient.rst @@ -0,0 +1,8 @@ +WorkRequestsClient +================== + +.. currentmodule:: oci.apigateway + +.. autoclass:: WorkRequestsClient + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/apigateway/client/oci.apigateway.WorkRequestsClientCompositeOperations.rst b/docs/api/apigateway/client/oci.apigateway.WorkRequestsClientCompositeOperations.rst new file mode 100644 index 0000000000..d992199019 --- /dev/null +++ b/docs/api/apigateway/client/oci.apigateway.WorkRequestsClientCompositeOperations.rst @@ -0,0 +1,8 @@ +WorkRequestsClientCompositeOperations +===================================== + +.. currentmodule:: oci.apigateway + +.. autoclass:: WorkRequestsClientCompositeOperations + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.AccessLogPolicy.rst b/docs/api/apigateway/models/oci.apigateway.models.AccessLogPolicy.rst new file mode 100644 index 0000000000..dc574417a0 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.AccessLogPolicy.rst @@ -0,0 +1,11 @@ +AccessLogPolicy +=============== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: AccessLogPolicy + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.AnonymousRouteAuthorizationPolicy.rst b/docs/api/apigateway/models/oci.apigateway.models.AnonymousRouteAuthorizationPolicy.rst new file mode 100644 index 0000000000..527453ea61 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.AnonymousRouteAuthorizationPolicy.rst @@ -0,0 +1,11 @@ +AnonymousRouteAuthorizationPolicy +================================= + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: AnonymousRouteAuthorizationPolicy + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.AnyOfRouteAuthorizationPolicy.rst b/docs/api/apigateway/models/oci.apigateway.models.AnyOfRouteAuthorizationPolicy.rst new file mode 100644 index 0000000000..c5e3cac9ef --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.AnyOfRouteAuthorizationPolicy.rst @@ -0,0 +1,11 @@ +AnyOfRouteAuthorizationPolicy +============================= + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: AnyOfRouteAuthorizationPolicy + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.ApiSpecification.rst b/docs/api/apigateway/models/oci.apigateway.models.ApiSpecification.rst new file mode 100644 index 0000000000..f96967bd5e --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.ApiSpecification.rst @@ -0,0 +1,11 @@ +ApiSpecification +================ + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: ApiSpecification + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.ApiSpecificationLoggingPolicies.rst b/docs/api/apigateway/models/oci.apigateway.models.ApiSpecificationLoggingPolicies.rst new file mode 100644 index 0000000000..551be59284 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.ApiSpecificationLoggingPolicies.rst @@ -0,0 +1,11 @@ +ApiSpecificationLoggingPolicies +=============================== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: ApiSpecificationLoggingPolicies + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.ApiSpecificationRequestPolicies.rst b/docs/api/apigateway/models/oci.apigateway.models.ApiSpecificationRequestPolicies.rst new file mode 100644 index 0000000000..491dc7e229 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.ApiSpecificationRequestPolicies.rst @@ -0,0 +1,11 @@ +ApiSpecificationRequestPolicies +=============================== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: ApiSpecificationRequestPolicies + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.ApiSpecificationRoute.rst b/docs/api/apigateway/models/oci.apigateway.models.ApiSpecificationRoute.rst new file mode 100644 index 0000000000..9df2da7d20 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.ApiSpecificationRoute.rst @@ -0,0 +1,11 @@ +ApiSpecificationRoute +===================== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: ApiSpecificationRoute + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.ApiSpecificationRouteBackend.rst b/docs/api/apigateway/models/oci.apigateway.models.ApiSpecificationRouteBackend.rst new file mode 100644 index 0000000000..b78743f04f --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.ApiSpecificationRouteBackend.rst @@ -0,0 +1,11 @@ +ApiSpecificationRouteBackend +============================ + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: ApiSpecificationRouteBackend + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.ApiSpecificationRouteRequestPolicies.rst b/docs/api/apigateway/models/oci.apigateway.models.ApiSpecificationRouteRequestPolicies.rst new file mode 100644 index 0000000000..7da1e9e825 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.ApiSpecificationRouteRequestPolicies.rst @@ -0,0 +1,11 @@ +ApiSpecificationRouteRequestPolicies +==================================== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: ApiSpecificationRouteRequestPolicies + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.AuthenticationOnlyRouteAuthorizationPolicy.rst b/docs/api/apigateway/models/oci.apigateway.models.AuthenticationOnlyRouteAuthorizationPolicy.rst new file mode 100644 index 0000000000..1a8dd1c824 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.AuthenticationOnlyRouteAuthorizationPolicy.rst @@ -0,0 +1,11 @@ +AuthenticationOnlyRouteAuthorizationPolicy +========================================== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: AuthenticationOnlyRouteAuthorizationPolicy + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.AuthenticationPolicy.rst b/docs/api/apigateway/models/oci.apigateway.models.AuthenticationPolicy.rst new file mode 100644 index 0000000000..c69e6d4edc --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.AuthenticationPolicy.rst @@ -0,0 +1,11 @@ +AuthenticationPolicy +==================== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: AuthenticationPolicy + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.ChangeDeploymentCompartmentDetails.rst b/docs/api/apigateway/models/oci.apigateway.models.ChangeDeploymentCompartmentDetails.rst new file mode 100644 index 0000000000..19b3ca3998 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.ChangeDeploymentCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeDeploymentCompartmentDetails +================================== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: ChangeDeploymentCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.ChangeGatewayCompartmentDetails.rst b/docs/api/apigateway/models/oci.apigateway.models.ChangeGatewayCompartmentDetails.rst new file mode 100644 index 0000000000..4455b442af --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.ChangeGatewayCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeGatewayCompartmentDetails +=============================== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: ChangeGatewayCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.CorsPolicy.rst b/docs/api/apigateway/models/oci.apigateway.models.CorsPolicy.rst new file mode 100644 index 0000000000..bdabdda7a6 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.CorsPolicy.rst @@ -0,0 +1,11 @@ +CorsPolicy +========== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: CorsPolicy + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.CreateDeploymentDetails.rst b/docs/api/apigateway/models/oci.apigateway.models.CreateDeploymentDetails.rst new file mode 100644 index 0000000000..e7b6b4027f --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.CreateDeploymentDetails.rst @@ -0,0 +1,11 @@ +CreateDeploymentDetails +======================= + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: CreateDeploymentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.CreateGatewayDetails.rst b/docs/api/apigateway/models/oci.apigateway.models.CreateGatewayDetails.rst new file mode 100644 index 0000000000..a4004108e6 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.CreateGatewayDetails.rst @@ -0,0 +1,11 @@ +CreateGatewayDetails +==================== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: CreateGatewayDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.CustomAuthenticationPolicy.rst b/docs/api/apigateway/models/oci.apigateway.models.CustomAuthenticationPolicy.rst new file mode 100644 index 0000000000..71cd5fd9d7 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.CustomAuthenticationPolicy.rst @@ -0,0 +1,11 @@ +CustomAuthenticationPolicy +========================== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: CustomAuthenticationPolicy + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.Deployment.rst b/docs/api/apigateway/models/oci.apigateway.models.Deployment.rst new file mode 100644 index 0000000000..908771ffaa --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.Deployment.rst @@ -0,0 +1,11 @@ +Deployment +========== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: Deployment + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.DeploymentCollection.rst b/docs/api/apigateway/models/oci.apigateway.models.DeploymentCollection.rst new file mode 100644 index 0000000000..596163c98c --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.DeploymentCollection.rst @@ -0,0 +1,11 @@ +DeploymentCollection +==================== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: DeploymentCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.DeploymentSummary.rst b/docs/api/apigateway/models/oci.apigateway.models.DeploymentSummary.rst new file mode 100644 index 0000000000..9046424db4 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.DeploymentSummary.rst @@ -0,0 +1,11 @@ +DeploymentSummary +================= + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: DeploymentSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.ExecutionLogPolicy.rst b/docs/api/apigateway/models/oci.apigateway.models.ExecutionLogPolicy.rst new file mode 100644 index 0000000000..625c8b3790 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.ExecutionLogPolicy.rst @@ -0,0 +1,11 @@ +ExecutionLogPolicy +================== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: ExecutionLogPolicy + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.Gateway.rst b/docs/api/apigateway/models/oci.apigateway.models.Gateway.rst new file mode 100644 index 0000000000..6d19b09c7f --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.Gateway.rst @@ -0,0 +1,11 @@ +Gateway +======= + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: Gateway + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.GatewayCollection.rst b/docs/api/apigateway/models/oci.apigateway.models.GatewayCollection.rst new file mode 100644 index 0000000000..1005c4cab9 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.GatewayCollection.rst @@ -0,0 +1,11 @@ +GatewayCollection +================= + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: GatewayCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.GatewaySummary.rst b/docs/api/apigateway/models/oci.apigateway.models.GatewaySummary.rst new file mode 100644 index 0000000000..5e84f31827 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.GatewaySummary.rst @@ -0,0 +1,11 @@ +GatewaySummary +============== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: GatewaySummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.HTTPBackend.rst b/docs/api/apigateway/models/oci.apigateway.models.HTTPBackend.rst new file mode 100644 index 0000000000..35650ff502 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.HTTPBackend.rst @@ -0,0 +1,11 @@ +HTTPBackend +=========== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: HTTPBackend + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.HeaderFieldSpecification.rst b/docs/api/apigateway/models/oci.apigateway.models.HeaderFieldSpecification.rst new file mode 100644 index 0000000000..f6f2674c9a --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.HeaderFieldSpecification.rst @@ -0,0 +1,11 @@ +HeaderFieldSpecification +======================== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: HeaderFieldSpecification + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.OracleFunctionBackend.rst b/docs/api/apigateway/models/oci.apigateway.models.OracleFunctionBackend.rst new file mode 100644 index 0000000000..5548b274d5 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.OracleFunctionBackend.rst @@ -0,0 +1,11 @@ +OracleFunctionBackend +===================== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: OracleFunctionBackend + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.RateLimitingPolicy.rst b/docs/api/apigateway/models/oci.apigateway.models.RateLimitingPolicy.rst new file mode 100644 index 0000000000..a5f2887af2 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.RateLimitingPolicy.rst @@ -0,0 +1,11 @@ +RateLimitingPolicy +================== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: RateLimitingPolicy + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.RouteAuthorizationPolicy.rst b/docs/api/apigateway/models/oci.apigateway.models.RouteAuthorizationPolicy.rst new file mode 100644 index 0000000000..e8c70ed154 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.RouteAuthorizationPolicy.rst @@ -0,0 +1,11 @@ +RouteAuthorizationPolicy +======================== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: RouteAuthorizationPolicy + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.StockResponseBackend.rst b/docs/api/apigateway/models/oci.apigateway.models.StockResponseBackend.rst new file mode 100644 index 0000000000..267fb521b9 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.StockResponseBackend.rst @@ -0,0 +1,11 @@ +StockResponseBackend +==================== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: StockResponseBackend + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.UpdateDeploymentDetails.rst b/docs/api/apigateway/models/oci.apigateway.models.UpdateDeploymentDetails.rst new file mode 100644 index 0000000000..f0152b6dbc --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.UpdateDeploymentDetails.rst @@ -0,0 +1,11 @@ +UpdateDeploymentDetails +======================= + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: UpdateDeploymentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.UpdateGatewayDetails.rst b/docs/api/apigateway/models/oci.apigateway.models.UpdateGatewayDetails.rst new file mode 100644 index 0000000000..7971128579 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.UpdateGatewayDetails.rst @@ -0,0 +1,11 @@ +UpdateGatewayDetails +==================== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: UpdateGatewayDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.WorkRequest.rst b/docs/api/apigateway/models/oci.apigateway.models.WorkRequest.rst new file mode 100644 index 0000000000..8afefc3b7f --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.WorkRequest.rst @@ -0,0 +1,11 @@ +WorkRequest +=========== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: WorkRequest + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.WorkRequestCollection.rst b/docs/api/apigateway/models/oci.apigateway.models.WorkRequestCollection.rst new file mode 100644 index 0000000000..ef1785fbfd --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.WorkRequestCollection.rst @@ -0,0 +1,11 @@ +WorkRequestCollection +===================== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: WorkRequestCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.WorkRequestError.rst b/docs/api/apigateway/models/oci.apigateway.models.WorkRequestError.rst new file mode 100644 index 0000000000..fa1e52d6d5 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.WorkRequestError.rst @@ -0,0 +1,11 @@ +WorkRequestError +================ + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: WorkRequestError + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.WorkRequestErrorCollection.rst b/docs/api/apigateway/models/oci.apigateway.models.WorkRequestErrorCollection.rst new file mode 100644 index 0000000000..23691e6c62 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.WorkRequestErrorCollection.rst @@ -0,0 +1,11 @@ +WorkRequestErrorCollection +========================== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: WorkRequestErrorCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.WorkRequestLog.rst b/docs/api/apigateway/models/oci.apigateway.models.WorkRequestLog.rst new file mode 100644 index 0000000000..7b403b6979 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.WorkRequestLog.rst @@ -0,0 +1,11 @@ +WorkRequestLog +============== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: WorkRequestLog + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.WorkRequestLogCollection.rst b/docs/api/apigateway/models/oci.apigateway.models.WorkRequestLogCollection.rst new file mode 100644 index 0000000000..9a1e9e8b0c --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.WorkRequestLogCollection.rst @@ -0,0 +1,11 @@ +WorkRequestLogCollection +======================== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: WorkRequestLogCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.WorkRequestResource.rst b/docs/api/apigateway/models/oci.apigateway.models.WorkRequestResource.rst new file mode 100644 index 0000000000..d9adb45603 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.WorkRequestResource.rst @@ -0,0 +1,11 @@ +WorkRequestResource +=================== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: WorkRequestResource + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/apigateway/models/oci.apigateway.models.WorkRequestSummary.rst b/docs/api/apigateway/models/oci.apigateway.models.WorkRequestSummary.rst new file mode 100644 index 0000000000..3e6e11b978 --- /dev/null +++ b/docs/api/apigateway/models/oci.apigateway.models.WorkRequestSummary.rst @@ -0,0 +1,11 @@ +WorkRequestSummary +================== + +.. currentmodule:: oci.apigateway.models + +.. autoclass:: WorkRequestSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/container_engine.rst b/docs/api/container_engine.rst index a66dfebfa1..c68330986b 100644 --- a/docs/api/container_engine.rst +++ b/docs/api/container_engine.rst @@ -38,6 +38,10 @@ Container Engine oci.container_engine.models.NodePoolOptions oci.container_engine.models.NodePoolPlacementConfigDetails oci.container_engine.models.NodePoolSummary + oci.container_engine.models.NodeSourceDetails + oci.container_engine.models.NodeSourceOption + oci.container_engine.models.NodeSourceViaImageDetails + oci.container_engine.models.NodeSourceViaImageOption oci.container_engine.models.UpdateClusterDetails oci.container_engine.models.UpdateNodePoolDetails oci.container_engine.models.UpdateNodePoolNodeConfigDetails diff --git a/docs/api/container_engine/models/oci.container_engine.models.NodeSourceDetails.rst b/docs/api/container_engine/models/oci.container_engine.models.NodeSourceDetails.rst new file mode 100644 index 0000000000..a9f5fb9816 --- /dev/null +++ b/docs/api/container_engine/models/oci.container_engine.models.NodeSourceDetails.rst @@ -0,0 +1,11 @@ +NodeSourceDetails +================= + +.. currentmodule:: oci.container_engine.models + +.. autoclass:: NodeSourceDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/container_engine/models/oci.container_engine.models.NodeSourceOption.rst b/docs/api/container_engine/models/oci.container_engine.models.NodeSourceOption.rst new file mode 100644 index 0000000000..f1ae710587 --- /dev/null +++ b/docs/api/container_engine/models/oci.container_engine.models.NodeSourceOption.rst @@ -0,0 +1,11 @@ +NodeSourceOption +================ + +.. currentmodule:: oci.container_engine.models + +.. autoclass:: NodeSourceOption + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/container_engine/models/oci.container_engine.models.NodeSourceViaImageDetails.rst b/docs/api/container_engine/models/oci.container_engine.models.NodeSourceViaImageDetails.rst new file mode 100644 index 0000000000..efa5aea13c --- /dev/null +++ b/docs/api/container_engine/models/oci.container_engine.models.NodeSourceViaImageDetails.rst @@ -0,0 +1,11 @@ +NodeSourceViaImageDetails +========================= + +.. currentmodule:: oci.container_engine.models + +.. autoclass:: NodeSourceViaImageDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/container_engine/models/oci.container_engine.models.NodeSourceViaImageOption.rst b/docs/api/container_engine/models/oci.container_engine.models.NodeSourceViaImageOption.rst new file mode 100644 index 0000000000..2208e7909d --- /dev/null +++ b/docs/api/container_engine/models/oci.container_engine.models.NodeSourceViaImageOption.rst @@ -0,0 +1,11 @@ +NodeSourceViaImageOption +======================== + +.. currentmodule:: oci.container_engine.models + +.. autoclass:: NodeSourceViaImageOption + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/core.rst b/docs/api/core.rst index 041a449380..7c9190cc77 100644 --- a/docs/api/core.rst +++ b/docs/api/core.rst @@ -90,6 +90,7 @@ Core Services oci.core.models.ConnectLocalPeeringGatewaysDetails oci.core.models.ConnectRemotePeeringConnectionsDetails oci.core.models.ConsoleHistory + oci.core.models.CopyBootVolumeBackupDetails oci.core.models.CopyVolumeBackupDetails oci.core.models.Cpe oci.core.models.CreateAppCatalogSubscriptionDetails diff --git a/docs/api/core/models/oci.core.models.CopyBootVolumeBackupDetails.rst b/docs/api/core/models/oci.core.models.CopyBootVolumeBackupDetails.rst new file mode 100644 index 0000000000..c75e819257 --- /dev/null +++ b/docs/api/core/models/oci.core.models.CopyBootVolumeBackupDetails.rst @@ -0,0 +1,11 @@ +CopyBootVolumeBackupDetails +=========================== + +.. currentmodule:: oci.core.models + +.. autoclass:: CopyBootVolumeBackupDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/dns.rst b/docs/api/dns.rst index 6159824eb7..3b87801c3e 100644 --- a/docs/api/dns.rst +++ b/docs/api/dns.rst @@ -19,10 +19,12 @@ DNS :template: autosummary/model_class.rst oci.dns.models.ChangeSteeringPolicyCompartmentDetails + oci.dns.models.ChangeTsigKeyCompartmentDetails oci.dns.models.ChangeZoneCompartmentDetails oci.dns.models.CreateMigratedDynectZoneDetails oci.dns.models.CreateSteeringPolicyAttachmentDetails oci.dns.models.CreateSteeringPolicyDetails + oci.dns.models.CreateTsigKeyDetails oci.dns.models.CreateZoneBaseDetails oci.dns.models.CreateZoneDetails oci.dns.models.DynectMigrationDetails @@ -57,10 +59,13 @@ DNS oci.dns.models.SteeringPolicyWeightedRule oci.dns.models.SteeringPolicyWeightedRuleCase oci.dns.models.TSIG + oci.dns.models.TsigKey + oci.dns.models.TsigKeySummary oci.dns.models.UpdateDomainRecordsDetails oci.dns.models.UpdateRRSetDetails oci.dns.models.UpdateSteeringPolicyAttachmentDetails oci.dns.models.UpdateSteeringPolicyDetails + oci.dns.models.UpdateTsigKeyDetails oci.dns.models.UpdateZoneDetails oci.dns.models.UpdateZoneRecordsDetails oci.dns.models.Zone diff --git a/docs/api/dns/models/oci.dns.models.ChangeTsigKeyCompartmentDetails.rst b/docs/api/dns/models/oci.dns.models.ChangeTsigKeyCompartmentDetails.rst new file mode 100644 index 0000000000..621ecf6f67 --- /dev/null +++ b/docs/api/dns/models/oci.dns.models.ChangeTsigKeyCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeTsigKeyCompartmentDetails +=============================== + +.. currentmodule:: oci.dns.models + +.. autoclass:: ChangeTsigKeyCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/dns/models/oci.dns.models.CreateTsigKeyDetails.rst b/docs/api/dns/models/oci.dns.models.CreateTsigKeyDetails.rst new file mode 100644 index 0000000000..5151cd5c0b --- /dev/null +++ b/docs/api/dns/models/oci.dns.models.CreateTsigKeyDetails.rst @@ -0,0 +1,11 @@ +CreateTsigKeyDetails +==================== + +.. currentmodule:: oci.dns.models + +.. autoclass:: CreateTsigKeyDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/dns/models/oci.dns.models.TsigKey.rst b/docs/api/dns/models/oci.dns.models.TsigKey.rst new file mode 100644 index 0000000000..925767c35c --- /dev/null +++ b/docs/api/dns/models/oci.dns.models.TsigKey.rst @@ -0,0 +1,11 @@ +TsigKey +======= + +.. currentmodule:: oci.dns.models + +.. autoclass:: TsigKey + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/dns/models/oci.dns.models.TsigKeySummary.rst b/docs/api/dns/models/oci.dns.models.TsigKeySummary.rst new file mode 100644 index 0000000000..d8be0b8212 --- /dev/null +++ b/docs/api/dns/models/oci.dns.models.TsigKeySummary.rst @@ -0,0 +1,11 @@ +TsigKeySummary +============== + +.. currentmodule:: oci.dns.models + +.. autoclass:: TsigKeySummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/dns/models/oci.dns.models.UpdateTsigKeyDetails.rst b/docs/api/dns/models/oci.dns.models.UpdateTsigKeyDetails.rst new file mode 100644 index 0000000000..9a97617f85 --- /dev/null +++ b/docs/api/dns/models/oci.dns.models.UpdateTsigKeyDetails.rst @@ -0,0 +1,11 @@ +UpdateTsigKeyDetails +==================== + +.. currentmodule:: oci.dns.models + +.. autoclass:: UpdateTsigKeyDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/key_management.rst b/docs/api/key_management.rst index 24d645aeb8..9af6027ad9 100644 --- a/docs/api/key_management.rst +++ b/docs/api/key_management.rst @@ -32,14 +32,19 @@ Key Management oci.key_management.models.EncryptedData oci.key_management.models.GenerateKeyDetails oci.key_management.models.GeneratedKey + oci.key_management.models.ImportKeyDetails + oci.key_management.models.ImportKeyVersionDetails oci.key_management.models.Key oci.key_management.models.KeyShape oci.key_management.models.KeySummary oci.key_management.models.KeyVersion oci.key_management.models.KeyVersionSummary oci.key_management.models.ScheduleKeyDeletionDetails + oci.key_management.models.ScheduleKeyVersionDeletionDetails oci.key_management.models.ScheduleVaultDeletionDetails oci.key_management.models.UpdateKeyDetails oci.key_management.models.UpdateVaultDetails oci.key_management.models.Vault oci.key_management.models.VaultSummary + oci.key_management.models.WrappedImportKey + oci.key_management.models.WrappingKey diff --git a/docs/api/key_management/models/oci.key_management.models.ImportKeyDetails.rst b/docs/api/key_management/models/oci.key_management.models.ImportKeyDetails.rst new file mode 100644 index 0000000000..7844dc7a38 --- /dev/null +++ b/docs/api/key_management/models/oci.key_management.models.ImportKeyDetails.rst @@ -0,0 +1,11 @@ +ImportKeyDetails +================ + +.. currentmodule:: oci.key_management.models + +.. autoclass:: ImportKeyDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/key_management/models/oci.key_management.models.ImportKeyVersionDetails.rst b/docs/api/key_management/models/oci.key_management.models.ImportKeyVersionDetails.rst new file mode 100644 index 0000000000..7aac1e46c7 --- /dev/null +++ b/docs/api/key_management/models/oci.key_management.models.ImportKeyVersionDetails.rst @@ -0,0 +1,11 @@ +ImportKeyVersionDetails +======================= + +.. currentmodule:: oci.key_management.models + +.. autoclass:: ImportKeyVersionDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/key_management/models/oci.key_management.models.ScheduleKeyVersionDeletionDetails.rst b/docs/api/key_management/models/oci.key_management.models.ScheduleKeyVersionDeletionDetails.rst new file mode 100644 index 0000000000..584f8f9e66 --- /dev/null +++ b/docs/api/key_management/models/oci.key_management.models.ScheduleKeyVersionDeletionDetails.rst @@ -0,0 +1,11 @@ +ScheduleKeyVersionDeletionDetails +================================= + +.. currentmodule:: oci.key_management.models + +.. autoclass:: ScheduleKeyVersionDeletionDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/key_management/models/oci.key_management.models.WrappedImportKey.rst b/docs/api/key_management/models/oci.key_management.models.WrappedImportKey.rst new file mode 100644 index 0000000000..5f6419424d --- /dev/null +++ b/docs/api/key_management/models/oci.key_management.models.WrappedImportKey.rst @@ -0,0 +1,11 @@ +WrappedImportKey +================ + +.. currentmodule:: oci.key_management.models + +.. autoclass:: WrappedImportKey + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/key_management/models/oci.key_management.models.WrappingKey.rst b/docs/api/key_management/models/oci.key_management.models.WrappingKey.rst new file mode 100644 index 0000000000..0097597e19 --- /dev/null +++ b/docs/api/key_management/models/oci.key_management.models.WrappingKey.rst @@ -0,0 +1,11 @@ +WrappingKey +=========== + +.. currentmodule:: oci.key_management.models + +.. autoclass:: WrappingKey + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/landing.rst b/docs/api/landing.rst index 9329f52e6b..93560acb56 100644 --- a/docs/api/landing.rst +++ b/docs/api/landing.rst @@ -5,6 +5,9 @@ API Reference * :doc:`Analytics ` * :doc:`Announcement ` +* :doc:`Deployment ` +* :doc:`Gateway ` +* :doc:`Work Requests ` * :doc:`Audit ` * :doc:`Auto Scaling ` * :doc:`Budget ` @@ -35,12 +38,14 @@ API Reference * :doc:`Limits ` * :doc:`Quotas ` * :doc:`Load Balancer ` +* :doc:`Marketplace ` * :doc:`Monitoring ` * :doc:`Object Storage ` * :doc:`Oce Instance ` * :doc:`Oda ` * :doc:`Notification Control Plane ` * :doc:`Notification Data Plane ` +* :doc:`Os Management ` * :doc:`Resource Manager ` * :doc:`Resource Search ` * :doc:`Stream Admin ` @@ -68,6 +73,7 @@ API Reference analytics announcements_service + apigateway audit autoscaling budget @@ -86,11 +92,13 @@ API Reference key_management limits load_balancer + marketplace monitoring object_storage oce oda ons + os_management resource_manager resource_search streaming diff --git a/docs/api/marketplace.rst b/docs/api/marketplace.rst new file mode 100644 index 0000000000..a4c5d8a8ca --- /dev/null +++ b/docs/api/marketplace.rst @@ -0,0 +1,46 @@ +Marketplace +=========== + +.. autosummary:: + :toctree: marketplace/client + :nosignatures: + :template: autosummary/service_client.rst + + oci.marketplace.MarketplaceClient + oci.marketplace.MarketplaceClientCompositeOperations + +-------- + Models +-------- + +.. autosummary:: + :toctree: marketplace/models + :nosignatures: + :template: autosummary/model_class.rst + + oci.marketplace.models.AcceptedAgreement + oci.marketplace.models.AcceptedAgreementSummary + oci.marketplace.models.Agreement + oci.marketplace.models.AgreementSummary + oci.marketplace.models.CategorySummary + oci.marketplace.models.CreateAcceptedAgreementDetails + oci.marketplace.models.DocumentationLink + oci.marketplace.models.ErrorEntity + oci.marketplace.models.ImageListingPackage + oci.marketplace.models.Item + oci.marketplace.models.Link + oci.marketplace.models.Listing + oci.marketplace.models.ListingPackage + oci.marketplace.models.ListingPackageSummary + oci.marketplace.models.ListingSummary + oci.marketplace.models.NamedLink + oci.marketplace.models.OrchestrationListingPackage + oci.marketplace.models.OrchestrationVariable + oci.marketplace.models.PricingModel + oci.marketplace.models.Publisher + oci.marketplace.models.PublisherSummary + oci.marketplace.models.Region + oci.marketplace.models.Screenshot + oci.marketplace.models.SupportContact + oci.marketplace.models.UpdateAcceptedAgreementDetails + oci.marketplace.models.UploadData diff --git a/docs/api/marketplace/client/oci.marketplace.MarketplaceClient.rst b/docs/api/marketplace/client/oci.marketplace.MarketplaceClient.rst new file mode 100644 index 0000000000..a2b574003f --- /dev/null +++ b/docs/api/marketplace/client/oci.marketplace.MarketplaceClient.rst @@ -0,0 +1,8 @@ +MarketplaceClient +================= + +.. currentmodule:: oci.marketplace + +.. autoclass:: MarketplaceClient + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/marketplace/client/oci.marketplace.MarketplaceClientCompositeOperations.rst b/docs/api/marketplace/client/oci.marketplace.MarketplaceClientCompositeOperations.rst new file mode 100644 index 0000000000..7ba1e41158 --- /dev/null +++ b/docs/api/marketplace/client/oci.marketplace.MarketplaceClientCompositeOperations.rst @@ -0,0 +1,8 @@ +MarketplaceClientCompositeOperations +==================================== + +.. currentmodule:: oci.marketplace + +.. autoclass:: MarketplaceClientCompositeOperations + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.AcceptedAgreement.rst b/docs/api/marketplace/models/oci.marketplace.models.AcceptedAgreement.rst new file mode 100644 index 0000000000..1c88f1022f --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.AcceptedAgreement.rst @@ -0,0 +1,11 @@ +AcceptedAgreement +================= + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: AcceptedAgreement + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.AcceptedAgreementSummary.rst b/docs/api/marketplace/models/oci.marketplace.models.AcceptedAgreementSummary.rst new file mode 100644 index 0000000000..4fab909dac --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.AcceptedAgreementSummary.rst @@ -0,0 +1,11 @@ +AcceptedAgreementSummary +======================== + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: AcceptedAgreementSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.Agreement.rst b/docs/api/marketplace/models/oci.marketplace.models.Agreement.rst new file mode 100644 index 0000000000..ad98dce5c3 --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.Agreement.rst @@ -0,0 +1,11 @@ +Agreement +========= + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: Agreement + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.AgreementSummary.rst b/docs/api/marketplace/models/oci.marketplace.models.AgreementSummary.rst new file mode 100644 index 0000000000..94fa6d7f65 --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.AgreementSummary.rst @@ -0,0 +1,11 @@ +AgreementSummary +================ + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: AgreementSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.CategorySummary.rst b/docs/api/marketplace/models/oci.marketplace.models.CategorySummary.rst new file mode 100644 index 0000000000..511db84d97 --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.CategorySummary.rst @@ -0,0 +1,11 @@ +CategorySummary +=============== + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: CategorySummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.CreateAcceptedAgreementDetails.rst b/docs/api/marketplace/models/oci.marketplace.models.CreateAcceptedAgreementDetails.rst new file mode 100644 index 0000000000..8274a29129 --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.CreateAcceptedAgreementDetails.rst @@ -0,0 +1,11 @@ +CreateAcceptedAgreementDetails +============================== + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: CreateAcceptedAgreementDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.DocumentationLink.rst b/docs/api/marketplace/models/oci.marketplace.models.DocumentationLink.rst new file mode 100644 index 0000000000..c80888c6bc --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.DocumentationLink.rst @@ -0,0 +1,11 @@ +DocumentationLink +================= + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: DocumentationLink + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.ErrorEntity.rst b/docs/api/marketplace/models/oci.marketplace.models.ErrorEntity.rst new file mode 100644 index 0000000000..b30e097dbc --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.ErrorEntity.rst @@ -0,0 +1,11 @@ +ErrorEntity +=========== + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: ErrorEntity + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.ImageListingPackage.rst b/docs/api/marketplace/models/oci.marketplace.models.ImageListingPackage.rst new file mode 100644 index 0000000000..3d99010530 --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.ImageListingPackage.rst @@ -0,0 +1,11 @@ +ImageListingPackage +=================== + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: ImageListingPackage + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.Item.rst b/docs/api/marketplace/models/oci.marketplace.models.Item.rst new file mode 100644 index 0000000000..d2c285c4ed --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.Item.rst @@ -0,0 +1,11 @@ +Item +==== + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: Item + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.Link.rst b/docs/api/marketplace/models/oci.marketplace.models.Link.rst new file mode 100644 index 0000000000..07b01608fd --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.Link.rst @@ -0,0 +1,11 @@ +Link +==== + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: Link + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.Listing.rst b/docs/api/marketplace/models/oci.marketplace.models.Listing.rst new file mode 100644 index 0000000000..d0dbc99753 --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.Listing.rst @@ -0,0 +1,11 @@ +Listing +======= + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: Listing + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.ListingPackage.rst b/docs/api/marketplace/models/oci.marketplace.models.ListingPackage.rst new file mode 100644 index 0000000000..3432315d5a --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.ListingPackage.rst @@ -0,0 +1,11 @@ +ListingPackage +============== + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: ListingPackage + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.ListingPackageSummary.rst b/docs/api/marketplace/models/oci.marketplace.models.ListingPackageSummary.rst new file mode 100644 index 0000000000..b6f3af0b94 --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.ListingPackageSummary.rst @@ -0,0 +1,11 @@ +ListingPackageSummary +===================== + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: ListingPackageSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.ListingSummary.rst b/docs/api/marketplace/models/oci.marketplace.models.ListingSummary.rst new file mode 100644 index 0000000000..0d2cf85d3e --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.ListingSummary.rst @@ -0,0 +1,11 @@ +ListingSummary +============== + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: ListingSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.NamedLink.rst b/docs/api/marketplace/models/oci.marketplace.models.NamedLink.rst new file mode 100644 index 0000000000..4fc26a75c8 --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.NamedLink.rst @@ -0,0 +1,11 @@ +NamedLink +========= + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: NamedLink + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.OrchestrationListingPackage.rst b/docs/api/marketplace/models/oci.marketplace.models.OrchestrationListingPackage.rst new file mode 100644 index 0000000000..b3a0aad646 --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.OrchestrationListingPackage.rst @@ -0,0 +1,11 @@ +OrchestrationListingPackage +=========================== + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: OrchestrationListingPackage + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.OrchestrationVariable.rst b/docs/api/marketplace/models/oci.marketplace.models.OrchestrationVariable.rst new file mode 100644 index 0000000000..8fa6ad0c93 --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.OrchestrationVariable.rst @@ -0,0 +1,11 @@ +OrchestrationVariable +===================== + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: OrchestrationVariable + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.PricingModel.rst b/docs/api/marketplace/models/oci.marketplace.models.PricingModel.rst new file mode 100644 index 0000000000..8ffa95aee0 --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.PricingModel.rst @@ -0,0 +1,11 @@ +PricingModel +============ + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: PricingModel + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.Publisher.rst b/docs/api/marketplace/models/oci.marketplace.models.Publisher.rst new file mode 100644 index 0000000000..bfc7fedd83 --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.Publisher.rst @@ -0,0 +1,11 @@ +Publisher +========= + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: Publisher + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.PublisherSummary.rst b/docs/api/marketplace/models/oci.marketplace.models.PublisherSummary.rst new file mode 100644 index 0000000000..f24f5f7ff3 --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.PublisherSummary.rst @@ -0,0 +1,11 @@ +PublisherSummary +================ + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: PublisherSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.Region.rst b/docs/api/marketplace/models/oci.marketplace.models.Region.rst new file mode 100644 index 0000000000..351fd1ae86 --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.Region.rst @@ -0,0 +1,11 @@ +Region +====== + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: Region + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.Screenshot.rst b/docs/api/marketplace/models/oci.marketplace.models.Screenshot.rst new file mode 100644 index 0000000000..b5dcd2c16f --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.Screenshot.rst @@ -0,0 +1,11 @@ +Screenshot +========== + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: Screenshot + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.SupportContact.rst b/docs/api/marketplace/models/oci.marketplace.models.SupportContact.rst new file mode 100644 index 0000000000..7c67d63591 --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.SupportContact.rst @@ -0,0 +1,11 @@ +SupportContact +============== + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: SupportContact + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.UpdateAcceptedAgreementDetails.rst b/docs/api/marketplace/models/oci.marketplace.models.UpdateAcceptedAgreementDetails.rst new file mode 100644 index 0000000000..c17a46af58 --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.UpdateAcceptedAgreementDetails.rst @@ -0,0 +1,11 @@ +UpdateAcceptedAgreementDetails +============================== + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: UpdateAcceptedAgreementDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/marketplace/models/oci.marketplace.models.UploadData.rst b/docs/api/marketplace/models/oci.marketplace.models.UploadData.rst new file mode 100644 index 0000000000..376784ce2f --- /dev/null +++ b/docs/api/marketplace/models/oci.marketplace.models.UploadData.rst @@ -0,0 +1,11 @@ +UploadData +========== + +.. currentmodule:: oci.marketplace.models + +.. autoclass:: UploadData + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/oce.rst b/docs/api/oce.rst index ed34b71881..b03d16d15c 100644 --- a/docs/api/oce.rst +++ b/docs/api/oce.rst @@ -20,7 +20,7 @@ Oce oci.oce.models.ChangeOceInstanceCompartmentDetails oci.oce.models.CreateOceInstanceDetails - oci.oce.models.DeleteOceInstanceDetails + oci.oce.models.IdentityStripeDetails oci.oce.models.OceInstance oci.oce.models.OceInstanceSummary oci.oce.models.UpdateOceInstanceDetails diff --git a/docs/api/oce/models/oci.oce.models.DeleteOceInstanceDetails.rst b/docs/api/oce/models/oci.oce.models.IdentityStripeDetails.rst similarity index 62% rename from docs/api/oce/models/oci.oce.models.DeleteOceInstanceDetails.rst rename to docs/api/oce/models/oci.oce.models.IdentityStripeDetails.rst index fd557d705d..df8285b097 100644 --- a/docs/api/oce/models/oci.oce.models.DeleteOceInstanceDetails.rst +++ b/docs/api/oce/models/oci.oce.models.IdentityStripeDetails.rst @@ -1,9 +1,9 @@ -DeleteOceInstanceDetails -======================== +IdentityStripeDetails +===================== .. currentmodule:: oci.oce.models -.. autoclass:: DeleteOceInstanceDetails +.. autoclass:: IdentityStripeDetails :show-inheritance: :special-members: __init__ :members: diff --git a/docs/api/os_management.rst b/docs/api/os_management.rst new file mode 100644 index 0000000000..fc2022b68a --- /dev/null +++ b/docs/api/os_management.rst @@ -0,0 +1,67 @@ +Os Management +============= + +.. autosummary:: + :toctree: os_management/client + :nosignatures: + :template: autosummary/service_client.rst + + oci.os_management.OsManagementClient + oci.os_management.OsManagementClientCompositeOperations + +-------- + Models +-------- + +.. autosummary:: + :toctree: os_management/models + :nosignatures: + :template: autosummary/model_class.rst + + oci.os_management.models.AddPackagesToSoftwareSourceDetails + oci.os_management.models.ApiError + oci.os_management.models.AttachChildSoftwareSourceToManagedInstanceDetails + oci.os_management.models.AttachParentSoftwareSourceToManagedInstanceDetails + oci.os_management.models.AvailableSoftwareSourceSummary + oci.os_management.models.AvailableUpdateSummary + oci.os_management.models.ChangeManagedInstanceGroupCompartmentDetails + oci.os_management.models.ChangeScheduledJobCompartmentDetails + oci.os_management.models.ChangeSoftwareSourceCompartmentDetails + oci.os_management.models.CreateManagedInstanceGroupDetails + oci.os_management.models.CreateScheduledJobDetails + oci.os_management.models.CreateSoftwareSourceDetails + oci.os_management.models.DetachChildSoftwareSourceFromManagedInstanceDetails + oci.os_management.models.DetachParentSoftwareSourceFromManagedInstanceDetails + oci.os_management.models.ErrataId + oci.os_management.models.Erratum + oci.os_management.models.ErratumSummary + oci.os_management.models.Id + oci.os_management.models.InstallablePackageSummary + oci.os_management.models.InstalledPackageSummary + oci.os_management.models.ManagedInstance + oci.os_management.models.ManagedInstanceGroup + oci.os_management.models.ManagedInstanceGroupSummary + oci.os_management.models.ManagedInstanceSummary + oci.os_management.models.ManagedInstanceUpdateDetails + oci.os_management.models.PackageName + oci.os_management.models.Recurrence + oci.os_management.models.RemovePackagesFromSoftwareSourceDetails + oci.os_management.models.ScheduledJob + oci.os_management.models.ScheduledJobSummary + oci.os_management.models.SoftwarePackage + oci.os_management.models.SoftwarePackageDependency + oci.os_management.models.SoftwarePackageFile + oci.os_management.models.SoftwarePackageSearchSummary + oci.os_management.models.SoftwarePackageSummary + oci.os_management.models.SoftwareSource + oci.os_management.models.SoftwareSourceId + oci.os_management.models.SoftwareSourceSummary + oci.os_management.models.UpdatablePackageSummary + oci.os_management.models.UpdateManagedInstanceGroupDetails + oci.os_management.models.UpdateScheduledJobDetails + oci.os_management.models.UpdateSoftwareSourceDetails + oci.os_management.models.WorkRequest + oci.os_management.models.WorkRequestError + oci.os_management.models.WorkRequestLogEntry + oci.os_management.models.WorkRequestResource + oci.os_management.models.WorkRequestSummary diff --git a/docs/api/os_management/client/oci.os_management.OsManagementClient.rst b/docs/api/os_management/client/oci.os_management.OsManagementClient.rst new file mode 100644 index 0000000000..6b04a17f1a --- /dev/null +++ b/docs/api/os_management/client/oci.os_management.OsManagementClient.rst @@ -0,0 +1,8 @@ +OsManagementClient +================== + +.. currentmodule:: oci.os_management + +.. autoclass:: OsManagementClient + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/os_management/client/oci.os_management.OsManagementClientCompositeOperations.rst b/docs/api/os_management/client/oci.os_management.OsManagementClientCompositeOperations.rst new file mode 100644 index 0000000000..b8b1ac7804 --- /dev/null +++ b/docs/api/os_management/client/oci.os_management.OsManagementClientCompositeOperations.rst @@ -0,0 +1,8 @@ +OsManagementClientCompositeOperations +===================================== + +.. currentmodule:: oci.os_management + +.. autoclass:: OsManagementClientCompositeOperations + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.AddPackagesToSoftwareSourceDetails.rst b/docs/api/os_management/models/oci.os_management.models.AddPackagesToSoftwareSourceDetails.rst new file mode 100644 index 0000000000..9aecf5a846 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.AddPackagesToSoftwareSourceDetails.rst @@ -0,0 +1,11 @@ +AddPackagesToSoftwareSourceDetails +================================== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: AddPackagesToSoftwareSourceDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.ApiError.rst b/docs/api/os_management/models/oci.os_management.models.ApiError.rst new file mode 100644 index 0000000000..1b1a7551aa --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.ApiError.rst @@ -0,0 +1,11 @@ +ApiError +======== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: ApiError + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.AttachChildSoftwareSourceToManagedInstanceDetails.rst b/docs/api/os_management/models/oci.os_management.models.AttachChildSoftwareSourceToManagedInstanceDetails.rst new file mode 100644 index 0000000000..f8dbe95e6d --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.AttachChildSoftwareSourceToManagedInstanceDetails.rst @@ -0,0 +1,11 @@ +AttachChildSoftwareSourceToManagedInstanceDetails +================================================= + +.. currentmodule:: oci.os_management.models + +.. autoclass:: AttachChildSoftwareSourceToManagedInstanceDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.AttachParentSoftwareSourceToManagedInstanceDetails.rst b/docs/api/os_management/models/oci.os_management.models.AttachParentSoftwareSourceToManagedInstanceDetails.rst new file mode 100644 index 0000000000..420a5ff029 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.AttachParentSoftwareSourceToManagedInstanceDetails.rst @@ -0,0 +1,11 @@ +AttachParentSoftwareSourceToManagedInstanceDetails +================================================== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: AttachParentSoftwareSourceToManagedInstanceDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.AvailableSoftwareSourceSummary.rst b/docs/api/os_management/models/oci.os_management.models.AvailableSoftwareSourceSummary.rst new file mode 100644 index 0000000000..167a96bf58 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.AvailableSoftwareSourceSummary.rst @@ -0,0 +1,11 @@ +AvailableSoftwareSourceSummary +============================== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: AvailableSoftwareSourceSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.AvailableUpdateSummary.rst b/docs/api/os_management/models/oci.os_management.models.AvailableUpdateSummary.rst new file mode 100644 index 0000000000..f18f256a99 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.AvailableUpdateSummary.rst @@ -0,0 +1,11 @@ +AvailableUpdateSummary +====================== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: AvailableUpdateSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.ChangeManagedInstanceGroupCompartmentDetails.rst b/docs/api/os_management/models/oci.os_management.models.ChangeManagedInstanceGroupCompartmentDetails.rst new file mode 100644 index 0000000000..8c7c2e35ef --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.ChangeManagedInstanceGroupCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeManagedInstanceGroupCompartmentDetails +============================================ + +.. currentmodule:: oci.os_management.models + +.. autoclass:: ChangeManagedInstanceGroupCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.ChangeScheduledJobCompartmentDetails.rst b/docs/api/os_management/models/oci.os_management.models.ChangeScheduledJobCompartmentDetails.rst new file mode 100644 index 0000000000..ed1e140bbd --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.ChangeScheduledJobCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeScheduledJobCompartmentDetails +==================================== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: ChangeScheduledJobCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.ChangeSoftwareSourceCompartmentDetails.rst b/docs/api/os_management/models/oci.os_management.models.ChangeSoftwareSourceCompartmentDetails.rst new file mode 100644 index 0000000000..c658a7e62b --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.ChangeSoftwareSourceCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeSoftwareSourceCompartmentDetails +====================================== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: ChangeSoftwareSourceCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.CreateManagedInstanceGroupDetails.rst b/docs/api/os_management/models/oci.os_management.models.CreateManagedInstanceGroupDetails.rst new file mode 100644 index 0000000000..d778a01dc8 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.CreateManagedInstanceGroupDetails.rst @@ -0,0 +1,11 @@ +CreateManagedInstanceGroupDetails +================================= + +.. currentmodule:: oci.os_management.models + +.. autoclass:: CreateManagedInstanceGroupDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.CreateScheduledJobDetails.rst b/docs/api/os_management/models/oci.os_management.models.CreateScheduledJobDetails.rst new file mode 100644 index 0000000000..ea7ee8f33c --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.CreateScheduledJobDetails.rst @@ -0,0 +1,11 @@ +CreateScheduledJobDetails +========================= + +.. currentmodule:: oci.os_management.models + +.. autoclass:: CreateScheduledJobDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.CreateSoftwareSourceDetails.rst b/docs/api/os_management/models/oci.os_management.models.CreateSoftwareSourceDetails.rst new file mode 100644 index 0000000000..f3b3e7a254 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.CreateSoftwareSourceDetails.rst @@ -0,0 +1,11 @@ +CreateSoftwareSourceDetails +=========================== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: CreateSoftwareSourceDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.DetachChildSoftwareSourceFromManagedInstanceDetails.rst b/docs/api/os_management/models/oci.os_management.models.DetachChildSoftwareSourceFromManagedInstanceDetails.rst new file mode 100644 index 0000000000..595f5104ab --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.DetachChildSoftwareSourceFromManagedInstanceDetails.rst @@ -0,0 +1,11 @@ +DetachChildSoftwareSourceFromManagedInstanceDetails +=================================================== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: DetachChildSoftwareSourceFromManagedInstanceDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.DetachParentSoftwareSourceFromManagedInstanceDetails.rst b/docs/api/os_management/models/oci.os_management.models.DetachParentSoftwareSourceFromManagedInstanceDetails.rst new file mode 100644 index 0000000000..f6e5ae1518 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.DetachParentSoftwareSourceFromManagedInstanceDetails.rst @@ -0,0 +1,11 @@ +DetachParentSoftwareSourceFromManagedInstanceDetails +==================================================== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: DetachParentSoftwareSourceFromManagedInstanceDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.ErrataId.rst b/docs/api/os_management/models/oci.os_management.models.ErrataId.rst new file mode 100644 index 0000000000..da8844f17b --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.ErrataId.rst @@ -0,0 +1,11 @@ +ErrataId +======== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: ErrataId + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.Erratum.rst b/docs/api/os_management/models/oci.os_management.models.Erratum.rst new file mode 100644 index 0000000000..fd455aa7b0 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.Erratum.rst @@ -0,0 +1,11 @@ +Erratum +======= + +.. currentmodule:: oci.os_management.models + +.. autoclass:: Erratum + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.ErratumSummary.rst b/docs/api/os_management/models/oci.os_management.models.ErratumSummary.rst new file mode 100644 index 0000000000..1b4ff54a97 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.ErratumSummary.rst @@ -0,0 +1,11 @@ +ErratumSummary +============== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: ErratumSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.Id.rst b/docs/api/os_management/models/oci.os_management.models.Id.rst new file mode 100644 index 0000000000..bf0dffb5e8 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.Id.rst @@ -0,0 +1,11 @@ +Id +== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: Id + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.InstallablePackageSummary.rst b/docs/api/os_management/models/oci.os_management.models.InstallablePackageSummary.rst new file mode 100644 index 0000000000..078d92af37 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.InstallablePackageSummary.rst @@ -0,0 +1,11 @@ +InstallablePackageSummary +========================= + +.. currentmodule:: oci.os_management.models + +.. autoclass:: InstallablePackageSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.InstalledPackageSummary.rst b/docs/api/os_management/models/oci.os_management.models.InstalledPackageSummary.rst new file mode 100644 index 0000000000..1ef6248f5b --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.InstalledPackageSummary.rst @@ -0,0 +1,11 @@ +InstalledPackageSummary +======================= + +.. currentmodule:: oci.os_management.models + +.. autoclass:: InstalledPackageSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.ManagedInstance.rst b/docs/api/os_management/models/oci.os_management.models.ManagedInstance.rst new file mode 100644 index 0000000000..711cd86d12 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.ManagedInstance.rst @@ -0,0 +1,11 @@ +ManagedInstance +=============== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: ManagedInstance + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.ManagedInstanceGroup.rst b/docs/api/os_management/models/oci.os_management.models.ManagedInstanceGroup.rst new file mode 100644 index 0000000000..fbfad96b81 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.ManagedInstanceGroup.rst @@ -0,0 +1,11 @@ +ManagedInstanceGroup +==================== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: ManagedInstanceGroup + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.ManagedInstanceGroupSummary.rst b/docs/api/os_management/models/oci.os_management.models.ManagedInstanceGroupSummary.rst new file mode 100644 index 0000000000..48bb1d068b --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.ManagedInstanceGroupSummary.rst @@ -0,0 +1,11 @@ +ManagedInstanceGroupSummary +=========================== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: ManagedInstanceGroupSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.ManagedInstanceSummary.rst b/docs/api/os_management/models/oci.os_management.models.ManagedInstanceSummary.rst new file mode 100644 index 0000000000..fba37c530b --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.ManagedInstanceSummary.rst @@ -0,0 +1,11 @@ +ManagedInstanceSummary +====================== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: ManagedInstanceSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.ManagedInstanceUpdateDetails.rst b/docs/api/os_management/models/oci.os_management.models.ManagedInstanceUpdateDetails.rst new file mode 100644 index 0000000000..2b43770069 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.ManagedInstanceUpdateDetails.rst @@ -0,0 +1,11 @@ +ManagedInstanceUpdateDetails +============================ + +.. currentmodule:: oci.os_management.models + +.. autoclass:: ManagedInstanceUpdateDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.PackageName.rst b/docs/api/os_management/models/oci.os_management.models.PackageName.rst new file mode 100644 index 0000000000..6dbbfe18e7 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.PackageName.rst @@ -0,0 +1,11 @@ +PackageName +=========== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: PackageName + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.Recurrence.rst b/docs/api/os_management/models/oci.os_management.models.Recurrence.rst new file mode 100644 index 0000000000..d0cb75b7e6 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.Recurrence.rst @@ -0,0 +1,11 @@ +Recurrence +========== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: Recurrence + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.RemovePackagesFromSoftwareSourceDetails.rst b/docs/api/os_management/models/oci.os_management.models.RemovePackagesFromSoftwareSourceDetails.rst new file mode 100644 index 0000000000..48516001b8 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.RemovePackagesFromSoftwareSourceDetails.rst @@ -0,0 +1,11 @@ +RemovePackagesFromSoftwareSourceDetails +======================================= + +.. currentmodule:: oci.os_management.models + +.. autoclass:: RemovePackagesFromSoftwareSourceDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.ScheduledJob.rst b/docs/api/os_management/models/oci.os_management.models.ScheduledJob.rst new file mode 100644 index 0000000000..125b21af3d --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.ScheduledJob.rst @@ -0,0 +1,11 @@ +ScheduledJob +============ + +.. currentmodule:: oci.os_management.models + +.. autoclass:: ScheduledJob + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.ScheduledJobSummary.rst b/docs/api/os_management/models/oci.os_management.models.ScheduledJobSummary.rst new file mode 100644 index 0000000000..871d1d056d --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.ScheduledJobSummary.rst @@ -0,0 +1,11 @@ +ScheduledJobSummary +=================== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: ScheduledJobSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.SoftwarePackage.rst b/docs/api/os_management/models/oci.os_management.models.SoftwarePackage.rst new file mode 100644 index 0000000000..d50a7e8929 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.SoftwarePackage.rst @@ -0,0 +1,11 @@ +SoftwarePackage +=============== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: SoftwarePackage + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.SoftwarePackageDependency.rst b/docs/api/os_management/models/oci.os_management.models.SoftwarePackageDependency.rst new file mode 100644 index 0000000000..24285cbb05 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.SoftwarePackageDependency.rst @@ -0,0 +1,11 @@ +SoftwarePackageDependency +========================= + +.. currentmodule:: oci.os_management.models + +.. autoclass:: SoftwarePackageDependency + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.SoftwarePackageFile.rst b/docs/api/os_management/models/oci.os_management.models.SoftwarePackageFile.rst new file mode 100644 index 0000000000..86ef51a242 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.SoftwarePackageFile.rst @@ -0,0 +1,11 @@ +SoftwarePackageFile +=================== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: SoftwarePackageFile + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.SoftwarePackageSearchSummary.rst b/docs/api/os_management/models/oci.os_management.models.SoftwarePackageSearchSummary.rst new file mode 100644 index 0000000000..65b21e5773 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.SoftwarePackageSearchSummary.rst @@ -0,0 +1,11 @@ +SoftwarePackageSearchSummary +============================ + +.. currentmodule:: oci.os_management.models + +.. autoclass:: SoftwarePackageSearchSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.SoftwarePackageSummary.rst b/docs/api/os_management/models/oci.os_management.models.SoftwarePackageSummary.rst new file mode 100644 index 0000000000..7d16554708 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.SoftwarePackageSummary.rst @@ -0,0 +1,11 @@ +SoftwarePackageSummary +====================== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: SoftwarePackageSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.SoftwareSource.rst b/docs/api/os_management/models/oci.os_management.models.SoftwareSource.rst new file mode 100644 index 0000000000..44992e3d36 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.SoftwareSource.rst @@ -0,0 +1,11 @@ +SoftwareSource +============== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: SoftwareSource + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.SoftwareSourceId.rst b/docs/api/os_management/models/oci.os_management.models.SoftwareSourceId.rst new file mode 100644 index 0000000000..b2e312e133 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.SoftwareSourceId.rst @@ -0,0 +1,11 @@ +SoftwareSourceId +================ + +.. currentmodule:: oci.os_management.models + +.. autoclass:: SoftwareSourceId + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.SoftwareSourceSummary.rst b/docs/api/os_management/models/oci.os_management.models.SoftwareSourceSummary.rst new file mode 100644 index 0000000000..5e6d5d8826 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.SoftwareSourceSummary.rst @@ -0,0 +1,11 @@ +SoftwareSourceSummary +===================== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: SoftwareSourceSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.UpdatablePackageSummary.rst b/docs/api/os_management/models/oci.os_management.models.UpdatablePackageSummary.rst new file mode 100644 index 0000000000..f05196d307 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.UpdatablePackageSummary.rst @@ -0,0 +1,11 @@ +UpdatablePackageSummary +======================= + +.. currentmodule:: oci.os_management.models + +.. autoclass:: UpdatablePackageSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.UpdateManagedInstanceGroupDetails.rst b/docs/api/os_management/models/oci.os_management.models.UpdateManagedInstanceGroupDetails.rst new file mode 100644 index 0000000000..b4ea6b9403 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.UpdateManagedInstanceGroupDetails.rst @@ -0,0 +1,11 @@ +UpdateManagedInstanceGroupDetails +================================= + +.. currentmodule:: oci.os_management.models + +.. autoclass:: UpdateManagedInstanceGroupDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.UpdateScheduledJobDetails.rst b/docs/api/os_management/models/oci.os_management.models.UpdateScheduledJobDetails.rst new file mode 100644 index 0000000000..3614d4bccd --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.UpdateScheduledJobDetails.rst @@ -0,0 +1,11 @@ +UpdateScheduledJobDetails +========================= + +.. currentmodule:: oci.os_management.models + +.. autoclass:: UpdateScheduledJobDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.UpdateSoftwareSourceDetails.rst b/docs/api/os_management/models/oci.os_management.models.UpdateSoftwareSourceDetails.rst new file mode 100644 index 0000000000..2d68c61680 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.UpdateSoftwareSourceDetails.rst @@ -0,0 +1,11 @@ +UpdateSoftwareSourceDetails +=========================== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: UpdateSoftwareSourceDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.WorkRequest.rst b/docs/api/os_management/models/oci.os_management.models.WorkRequest.rst new file mode 100644 index 0000000000..d3fb988bd9 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.WorkRequest.rst @@ -0,0 +1,11 @@ +WorkRequest +=========== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: WorkRequest + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.WorkRequestError.rst b/docs/api/os_management/models/oci.os_management.models.WorkRequestError.rst new file mode 100644 index 0000000000..e119b5d035 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.WorkRequestError.rst @@ -0,0 +1,11 @@ +WorkRequestError +================ + +.. currentmodule:: oci.os_management.models + +.. autoclass:: WorkRequestError + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.WorkRequestLogEntry.rst b/docs/api/os_management/models/oci.os_management.models.WorkRequestLogEntry.rst new file mode 100644 index 0000000000..cb516335df --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.WorkRequestLogEntry.rst @@ -0,0 +1,11 @@ +WorkRequestLogEntry +=================== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: WorkRequestLogEntry + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.WorkRequestResource.rst b/docs/api/os_management/models/oci.os_management.models.WorkRequestResource.rst new file mode 100644 index 0000000000..76f5a161e6 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.WorkRequestResource.rst @@ -0,0 +1,11 @@ +WorkRequestResource +=================== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: WorkRequestResource + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/os_management/models/oci.os_management.models.WorkRequestSummary.rst b/docs/api/os_management/models/oci.os_management.models.WorkRequestSummary.rst new file mode 100644 index 0000000000..e27033d6d4 --- /dev/null +++ b/docs/api/os_management/models/oci.os_management.models.WorkRequestSummary.rst @@ -0,0 +1,11 @@ +WorkRequestSummary +================== + +.. currentmodule:: oci.os_management.models + +.. autoclass:: WorkRequestSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/src/oci/__init__.py b/src/oci/__init__.py index 8922ab87cf..c815589991 100644 --- a/src/oci/__init__.py +++ b/src/oci/__init__.py @@ -1,7 +1,7 @@ # coding: utf-8 # Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. -from . import analytics, announcements_service, audit, autoscaling, budget, container_engine, core, database, dns, dts, email, events, file_storage, functions, healthchecks, identity, integration, key_management, limits, load_balancer, monitoring, object_storage, oce, oda, ons, resource_manager, resource_search, streaming, waas, work_requests +from . import analytics, announcements_service, apigateway, audit, autoscaling, budget, container_engine, core, database, dns, dts, email, events, file_storage, functions, healthchecks, identity, integration, key_management, limits, load_balancer, marketplace, monitoring, object_storage, oce, oda, ons, os_management, resource_manager, resource_search, streaming, waas, work_requests from . import auth, config, constants, decorators, exceptions, regions, pagination, retry, fips from .base_client import BaseClient from .request import Request @@ -14,5 +14,5 @@ __all__ = [ "BaseClient", "Error", "Request", "Response", "Signer", "config", "constants", "decorators", "exceptions", "regions", "wait_until", "pagination", "auth", "retry", "fips", - "analytics", "announcements_service", "audit", "autoscaling", "budget", "container_engine", "core", "database", "dns", "dts", "email", "events", "file_storage", "functions", "healthchecks", "identity", "integration", "key_management", "limits", "load_balancer", "monitoring", "object_storage", "oce", "oda", "ons", "resource_manager", "resource_search", "streaming", "waas", "work_requests" + "analytics", "announcements_service", "apigateway", "audit", "autoscaling", "budget", "container_engine", "core", "database", "dns", "dts", "email", "events", "file_storage", "functions", "healthchecks", "identity", "integration", "key_management", "limits", "load_balancer", "marketplace", "monitoring", "object_storage", "oce", "oda", "ons", "os_management", "resource_manager", "resource_search", "streaming", "waas", "work_requests" ] diff --git a/src/oci/container_engine/models/__init__.py b/src/oci/container_engine/models/__init__.py index 20dfb7fca3..06d0ea98da 100644 --- a/src/oci/container_engine/models/__init__.py +++ b/src/oci/container_engine/models/__init__.py @@ -23,6 +23,10 @@ from .node_pool_options import NodePoolOptions from .node_pool_placement_config_details import NodePoolPlacementConfigDetails from .node_pool_summary import NodePoolSummary +from .node_source_details import NodeSourceDetails +from .node_source_option import NodeSourceOption +from .node_source_via_image_details import NodeSourceViaImageDetails +from .node_source_via_image_option import NodeSourceViaImageOption from .update_cluster_details import UpdateClusterDetails from .update_node_pool_details import UpdateNodePoolDetails from .update_node_pool_node_config_details import UpdateNodePoolNodeConfigDetails @@ -54,6 +58,10 @@ "NodePoolOptions": NodePoolOptions, "NodePoolPlacementConfigDetails": NodePoolPlacementConfigDetails, "NodePoolSummary": NodePoolSummary, + "NodeSourceDetails": NodeSourceDetails, + "NodeSourceOption": NodeSourceOption, + "NodeSourceViaImageDetails": NodeSourceViaImageDetails, + "NodeSourceViaImageOption": NodeSourceViaImageOption, "UpdateClusterDetails": UpdateClusterDetails, "UpdateNodePoolDetails": UpdateNodePoolDetails, "UpdateNodePoolNodeConfigDetails": UpdateNodePoolNodeConfigDetails, diff --git a/src/oci/container_engine/models/create_cluster_kubeconfig_content_details.py b/src/oci/container_engine/models/create_cluster_kubeconfig_content_details.py index 5a61448393..3561664578 100644 --- a/src/oci/container_engine/models/create_cluster_kubeconfig_content_details.py +++ b/src/oci/container_engine/models/create_cluster_kubeconfig_content_details.py @@ -43,7 +43,7 @@ def __init__(self, **kwargs): def token_version(self): """ Gets the token_version of this CreateClusterKubeconfigContentDetails. - The version of the kubeconfig token. Supported values 1.0.0 and 2.0.0 + The version of the kubeconfig token. Supported value 2.0.0 :return: The token_version of this CreateClusterKubeconfigContentDetails. @@ -55,7 +55,7 @@ def token_version(self): def token_version(self, token_version): """ Sets the token_version of this CreateClusterKubeconfigContentDetails. - The version of the kubeconfig token. Supported values 1.0.0 and 2.0.0 + The version of the kubeconfig token. Supported value 2.0.0 :param token_version: The token_version of this CreateClusterKubeconfigContentDetails. @@ -67,8 +67,7 @@ def token_version(self, token_version): def expiration(self): """ Gets the expiration of this CreateClusterKubeconfigContentDetails. - The desired expiration, in seconds, to use for the kubeconfig token. - Important Note, expiration field is only honored for token version 1.0.0 + Deprecated. This field is no longer used. :return: The expiration of this CreateClusterKubeconfigContentDetails. @@ -80,8 +79,7 @@ def expiration(self): def expiration(self, expiration): """ Sets the expiration of this CreateClusterKubeconfigContentDetails. - The desired expiration, in seconds, to use for the kubeconfig token. - Important Note, expiration field is only honored for token version 1.0.0 + Deprecated. This field is no longer used. :param expiration: The expiration of this CreateClusterKubeconfigContentDetails. diff --git a/src/oci/container_engine/models/create_node_pool_details.py b/src/oci/container_engine/models/create_node_pool_details.py index 06afc7a555..881f9ccc27 100644 --- a/src/oci/container_engine/models/create_node_pool_details.py +++ b/src/oci/container_engine/models/create_node_pool_details.py @@ -41,6 +41,10 @@ def __init__(self, **kwargs): The value to assign to the node_image_name property of this CreateNodePoolDetails. :type node_image_name: str + :param node_source_details: + The value to assign to the node_source_details property of this CreateNodePoolDetails. + :type node_source_details: NodeSourceDetails + :param node_shape: The value to assign to the node_shape property of this CreateNodePoolDetails. :type node_shape: str @@ -73,6 +77,7 @@ def __init__(self, **kwargs): 'kubernetes_version': 'str', 'node_metadata': 'dict(str, str)', 'node_image_name': 'str', + 'node_source_details': 'NodeSourceDetails', 'node_shape': 'str', 'initial_node_labels': 'list[KeyValue]', 'ssh_public_key': 'str', @@ -88,6 +93,7 @@ def __init__(self, **kwargs): 'kubernetes_version': 'kubernetesVersion', 'node_metadata': 'nodeMetadata', 'node_image_name': 'nodeImageName', + 'node_source_details': 'nodeSourceDetails', 'node_shape': 'nodeShape', 'initial_node_labels': 'initialNodeLabels', 'ssh_public_key': 'sshPublicKey', @@ -102,6 +108,7 @@ def __init__(self, **kwargs): self._kubernetes_version = None self._node_metadata = None self._node_image_name = None + self._node_source_details = None self._node_shape = None self._initial_node_labels = None self._ssh_public_key = None @@ -232,7 +239,9 @@ def node_metadata(self, node_metadata): @property def node_image_name(self): """ - **[Required]** Gets the node_image_name of this CreateNodePoolDetails. + Gets the node_image_name of this CreateNodePoolDetails. + Deprecated. Use `nodeSourceDetails` instead. + If you specify values for both, this value is ignored. The name of the image running on the nodes in the node pool. @@ -245,6 +254,8 @@ def node_image_name(self): def node_image_name(self, node_image_name): """ Sets the node_image_name of this CreateNodePoolDetails. + Deprecated. Use `nodeSourceDetails` instead. + If you specify values for both, this value is ignored. The name of the image running on the nodes in the node pool. @@ -253,6 +264,30 @@ def node_image_name(self, node_image_name): """ self._node_image_name = node_image_name + @property + def node_source_details(self): + """ + Gets the node_source_details of this CreateNodePoolDetails. + Specify the source to use to launch nodes in the node pool. Currently, image is the only supported source. + + + :return: The node_source_details of this CreateNodePoolDetails. + :rtype: NodeSourceDetails + """ + return self._node_source_details + + @node_source_details.setter + def node_source_details(self, node_source_details): + """ + Sets the node_source_details of this CreateNodePoolDetails. + Specify the source to use to launch nodes in the node pool. Currently, image is the only supported source. + + + :param node_source_details: The node_source_details of this CreateNodePoolDetails. + :type: NodeSourceDetails + """ + self._node_source_details = node_source_details + @property def node_shape(self): """ diff --git a/src/oci/container_engine/models/node_pool.py b/src/oci/container_engine/models/node_pool.py index 054da9d4e9..671710e0d3 100644 --- a/src/oci/container_engine/models/node_pool.py +++ b/src/oci/container_engine/models/node_pool.py @@ -49,6 +49,10 @@ def __init__(self, **kwargs): The value to assign to the node_image_name property of this NodePool. :type node_image_name: str + :param node_source: + The value to assign to the node_source property of this NodePool. + :type node_source: NodeSourceOption + :param node_shape: The value to assign to the node_shape property of this NodePool. :type node_shape: str @@ -87,6 +91,7 @@ def __init__(self, **kwargs): 'node_metadata': 'dict(str, str)', 'node_image_id': 'str', 'node_image_name': 'str', + 'node_source': 'NodeSourceOption', 'node_shape': 'str', 'initial_node_labels': 'list[KeyValue]', 'ssh_public_key': 'str', @@ -105,6 +110,7 @@ def __init__(self, **kwargs): 'node_metadata': 'nodeMetadata', 'node_image_id': 'nodeImageId', 'node_image_name': 'nodeImageName', + 'node_source': 'nodeSource', 'node_shape': 'nodeShape', 'initial_node_labels': 'initialNodeLabels', 'ssh_public_key': 'sshPublicKey', @@ -122,6 +128,7 @@ def __init__(self, **kwargs): self._node_metadata = None self._node_image_id = None self._node_image_name = None + self._node_source = None self._node_shape = None self._initial_node_labels = None self._ssh_public_key = None @@ -278,7 +285,7 @@ def node_metadata(self, node_metadata): def node_image_id(self): """ Gets the node_image_id of this NodePool. - The OCID of the image running on the nodes in the node pool. + Deprecated. see `nodeSource`. The OCID of the image running on the nodes in the node pool. :return: The node_image_id of this NodePool. @@ -290,7 +297,7 @@ def node_image_id(self): def node_image_id(self, node_image_id): """ Sets the node_image_id of this NodePool. - The OCID of the image running on the nodes in the node pool. + Deprecated. see `nodeSource`. The OCID of the image running on the nodes in the node pool. :param node_image_id: The node_image_id of this NodePool. @@ -302,7 +309,7 @@ def node_image_id(self, node_image_id): def node_image_name(self): """ Gets the node_image_name of this NodePool. - The name of the image running on the nodes in the node pool. + Deprecated. see `nodeSource`. The name of the image running on the nodes in the node pool. :return: The node_image_name of this NodePool. @@ -314,7 +321,7 @@ def node_image_name(self): def node_image_name(self, node_image_name): """ Sets the node_image_name of this NodePool. - The name of the image running on the nodes in the node pool. + Deprecated. see `nodeSource`. The name of the image running on the nodes in the node pool. :param node_image_name: The node_image_name of this NodePool. @@ -322,6 +329,30 @@ def node_image_name(self, node_image_name): """ self._node_image_name = node_image_name + @property + def node_source(self): + """ + Gets the node_source of this NodePool. + Source running on the nodes in the node pool. + + + :return: The node_source of this NodePool. + :rtype: NodeSourceOption + """ + return self._node_source + + @node_source.setter + def node_source(self, node_source): + """ + Sets the node_source of this NodePool. + Source running on the nodes in the node pool. + + + :param node_source: The node_source of this NodePool. + :type: NodeSourceOption + """ + self._node_source = node_source + @property def node_shape(self): """ diff --git a/src/oci/container_engine/models/node_pool_options.py b/src/oci/container_engine/models/node_pool_options.py index 92ac74dcea..fc74e90a62 100644 --- a/src/oci/container_engine/models/node_pool_options.py +++ b/src/oci/container_engine/models/node_pool_options.py @@ -29,22 +29,29 @@ def __init__(self, **kwargs): The value to assign to the images property of this NodePoolOptions. :type images: list[str] + :param sources: + The value to assign to the sources property of this NodePoolOptions. + :type sources: list[NodeSourceOption] + """ self.swagger_types = { 'kubernetes_versions': 'list[str]', 'shapes': 'list[str]', - 'images': 'list[str]' + 'images': 'list[str]', + 'sources': 'list[NodeSourceOption]' } self.attribute_map = { 'kubernetes_versions': 'kubernetesVersions', 'shapes': 'shapes', - 'images': 'images' + 'images': 'images', + 'sources': 'sources' } self._kubernetes_versions = None self._shapes = None self._images = None + self._sources = None @property def kubernetes_versions(self): @@ -98,7 +105,9 @@ def shapes(self, shapes): def images(self): """ Gets the images of this NodePoolOptions. - Available image names. + Deprecated. See sources. + When creating a node pool using the `CreateNodePoolDetails` object, only image names contained in this + property can be passed to the `nodeImageName` property. :return: The images of this NodePoolOptions. @@ -110,7 +119,9 @@ def images(self): def images(self, images): """ Sets the images of this NodePoolOptions. - Available image names. + Deprecated. See sources. + When creating a node pool using the `CreateNodePoolDetails` object, only image names contained in this + property can be passed to the `nodeImageName` property. :param images: The images of this NodePoolOptions. @@ -118,6 +129,30 @@ def images(self, images): """ self._images = images + @property + def sources(self): + """ + Gets the sources of this NodePoolOptions. + Available source of the node. + + + :return: The sources of this NodePoolOptions. + :rtype: list[NodeSourceOption] + """ + return self._sources + + @sources.setter + def sources(self, sources): + """ + Sets the sources of this NodePoolOptions. + Available source of the node. + + + :param sources: The sources of this NodePoolOptions. + :type: list[NodeSourceOption] + """ + self._sources = sources + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/container_engine/models/node_pool_summary.py b/src/oci/container_engine/models/node_pool_summary.py index c8eeae4df6..3f5f517918 100644 --- a/src/oci/container_engine/models/node_pool_summary.py +++ b/src/oci/container_engine/models/node_pool_summary.py @@ -45,6 +45,10 @@ def __init__(self, **kwargs): The value to assign to the node_image_name property of this NodePoolSummary. :type node_image_name: str + :param node_source: + The value to assign to the node_source property of this NodePoolSummary. + :type node_source: NodeSourceOption + :param node_shape: The value to assign to the node_shape property of this NodePoolSummary. :type node_shape: str @@ -78,6 +82,7 @@ def __init__(self, **kwargs): 'kubernetes_version': 'str', 'node_image_id': 'str', 'node_image_name': 'str', + 'node_source': 'NodeSourceOption', 'node_shape': 'str', 'initial_node_labels': 'list[KeyValue]', 'ssh_public_key': 'str', @@ -94,6 +99,7 @@ def __init__(self, **kwargs): 'kubernetes_version': 'kubernetesVersion', 'node_image_id': 'nodeImageId', 'node_image_name': 'nodeImageName', + 'node_source': 'nodeSource', 'node_shape': 'nodeShape', 'initial_node_labels': 'initialNodeLabels', 'ssh_public_key': 'sshPublicKey', @@ -109,6 +115,7 @@ def __init__(self, **kwargs): self._kubernetes_version = None self._node_image_id = None self._node_image_name = None + self._node_source = None self._node_shape = None self._initial_node_labels = None self._ssh_public_key = None @@ -240,7 +247,7 @@ def kubernetes_version(self, kubernetes_version): def node_image_id(self): """ Gets the node_image_id of this NodePoolSummary. - The OCID of the image running on the nodes in the node pool. + Deprecated. see `nodeSource`. The OCID of the image running on the nodes in the node pool. :return: The node_image_id of this NodePoolSummary. @@ -252,7 +259,7 @@ def node_image_id(self): def node_image_id(self, node_image_id): """ Sets the node_image_id of this NodePoolSummary. - The OCID of the image running on the nodes in the node pool. + Deprecated. see `nodeSource`. The OCID of the image running on the nodes in the node pool. :param node_image_id: The node_image_id of this NodePoolSummary. @@ -264,7 +271,7 @@ def node_image_id(self, node_image_id): def node_image_name(self): """ Gets the node_image_name of this NodePoolSummary. - The name of the image running on the nodes in the node pool. + Deprecated. see `nodeSource`. The name of the image running on the nodes in the node pool. :return: The node_image_name of this NodePoolSummary. @@ -276,7 +283,7 @@ def node_image_name(self): def node_image_name(self, node_image_name): """ Sets the node_image_name of this NodePoolSummary. - The name of the image running on the nodes in the node pool. + Deprecated. see `nodeSource`. The name of the image running on the nodes in the node pool. :param node_image_name: The node_image_name of this NodePoolSummary. @@ -284,6 +291,30 @@ def node_image_name(self, node_image_name): """ self._node_image_name = node_image_name + @property + def node_source(self): + """ + Gets the node_source of this NodePoolSummary. + Source running on the nodes in the node pool. + + + :return: The node_source of this NodePoolSummary. + :rtype: NodeSourceOption + """ + return self._node_source + + @node_source.setter + def node_source(self, node_source): + """ + Sets the node_source of this NodePoolSummary. + Source running on the nodes in the node pool. + + + :param node_source: The node_source of this NodePoolSummary. + :type: NodeSourceOption + """ + self._node_source = node_source + @property def node_shape(self): """ diff --git a/src/oci/container_engine/models/node_source_details.py b/src/oci/container_engine/models/node_source_details.py new file mode 100644 index 0000000000..66fef21dfe --- /dev/null +++ b/src/oci/container_engine/models/node_source_details.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class NodeSourceDetails(object): + """ + The details of the node's source. + """ + + #: A constant which can be used with the source_type property of a NodeSourceDetails. + #: This constant has a value of "IMAGE" + SOURCE_TYPE_IMAGE = "IMAGE" + + def __init__(self, **kwargs): + """ + Initializes a new NodeSourceDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.container_engine.models.NodeSourceViaImageDetails` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param source_type: + The value to assign to the source_type property of this NodeSourceDetails. + Allowed values for this property are: "IMAGE" + :type source_type: str + + """ + self.swagger_types = { + 'source_type': 'str' + } + + self.attribute_map = { + 'source_type': 'sourceType' + } + + self._source_type = None + + @staticmethod + def get_subtype(object_dictionary): + """ + Given the hash representation of a subtype of this class, + use the info in the hash to return the class of the subtype. + """ + type = object_dictionary['sourceType'] + + if type == 'IMAGE': + return 'NodeSourceViaImageDetails' + else: + return 'NodeSourceDetails' + + @property + def source_type(self): + """ + **[Required]** Gets the source_type of this NodeSourceDetails. + The source type for the node. + Use `IMAGE` when specifying an OCID of an image. + + Allowed values for this property are: "IMAGE" + + + :return: The source_type of this NodeSourceDetails. + :rtype: str + """ + return self._source_type + + @source_type.setter + def source_type(self, source_type): + """ + Sets the source_type of this NodeSourceDetails. + The source type for the node. + Use `IMAGE` when specifying an OCID of an image. + + + :param source_type: The source_type of this NodeSourceDetails. + :type: str + """ + allowed_values = ["IMAGE"] + if not value_allowed_none_or_none_sentinel(source_type, allowed_values): + raise ValueError( + "Invalid value for `source_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._source_type = source_type + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/container_engine/models/node_source_option.py b/src/oci/container_engine/models/node_source_option.py new file mode 100644 index 0000000000..8237772178 --- /dev/null +++ b/src/oci/container_engine/models/node_source_option.py @@ -0,0 +1,131 @@ +# coding: utf-8 +# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class NodeSourceOption(object): + """ + The source option for the node. + """ + + #: A constant which can be used with the source_type property of a NodeSourceOption. + #: This constant has a value of "IMAGE" + SOURCE_TYPE_IMAGE = "IMAGE" + + def __init__(self, **kwargs): + """ + Initializes a new NodeSourceOption object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.container_engine.models.NodeSourceViaImageOption` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param source_type: + The value to assign to the source_type property of this NodeSourceOption. + Allowed values for this property are: "IMAGE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type source_type: str + + :param source_name: + The value to assign to the source_name property of this NodeSourceOption. + :type source_name: str + + """ + self.swagger_types = { + 'source_type': 'str', + 'source_name': 'str' + } + + self.attribute_map = { + 'source_type': 'sourceType', + 'source_name': 'sourceName' + } + + self._source_type = None + self._source_name = None + + @staticmethod + def get_subtype(object_dictionary): + """ + Given the hash representation of a subtype of this class, + use the info in the hash to return the class of the subtype. + """ + type = object_dictionary['sourceType'] + + if type == 'IMAGE': + return 'NodeSourceViaImageOption' + else: + return 'NodeSourceOption' + + @property + def source_type(self): + """ + **[Required]** Gets the source_type of this NodeSourceOption. + The source type of this option. + `IMAGE` means the OCID is of an image. + + Allowed values for this property are: "IMAGE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The source_type of this NodeSourceOption. + :rtype: str + """ + return self._source_type + + @source_type.setter + def source_type(self, source_type): + """ + Sets the source_type of this NodeSourceOption. + The source type of this option. + `IMAGE` means the OCID is of an image. + + + :param source_type: The source_type of this NodeSourceOption. + :type: str + """ + allowed_values = ["IMAGE"] + if not value_allowed_none_or_none_sentinel(source_type, allowed_values): + source_type = 'UNKNOWN_ENUM_VALUE' + self._source_type = source_type + + @property + def source_name(self): + """ + Gets the source_name of this NodeSourceOption. + The user-friendly name of the entity corresponding to the OCID. + + + :return: The source_name of this NodeSourceOption. + :rtype: str + """ + return self._source_name + + @source_name.setter + def source_name(self, source_name): + """ + Sets the source_name of this NodeSourceOption. + The user-friendly name of the entity corresponding to the OCID. + + + :param source_name: The source_name of this NodeSourceOption. + :type: str + """ + self._source_name = source_name + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/container_engine/models/node_source_via_image_details.py b/src/oci/container_engine/models/node_source_via_image_details.py new file mode 100644 index 0000000000..af819080fb --- /dev/null +++ b/src/oci/container_engine/models/node_source_via_image_details.py @@ -0,0 +1,79 @@ +# coding: utf-8 +# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. + +from .node_source_details import NodeSourceDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class NodeSourceViaImageDetails(NodeSourceDetails): + """ + Details of the image running on the node. + """ + + def __init__(self, **kwargs): + """ + Initializes a new NodeSourceViaImageDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.container_engine.models.NodeSourceViaImageDetails.source_type` attribute + of this class is ``IMAGE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param source_type: + The value to assign to the source_type property of this NodeSourceViaImageDetails. + Allowed values for this property are: "IMAGE" + :type source_type: str + + :param image_id: + The value to assign to the image_id property of this NodeSourceViaImageDetails. + :type image_id: str + + """ + self.swagger_types = { + 'source_type': 'str', + 'image_id': 'str' + } + + self.attribute_map = { + 'source_type': 'sourceType', + 'image_id': 'imageId' + } + + self._source_type = None + self._image_id = None + self._source_type = 'IMAGE' + + @property + def image_id(self): + """ + **[Required]** Gets the image_id of this NodeSourceViaImageDetails. + The OCID of the image used to boot the node. + + + :return: The image_id of this NodeSourceViaImageDetails. + :rtype: str + """ + return self._image_id + + @image_id.setter + def image_id(self, image_id): + """ + Sets the image_id of this NodeSourceViaImageDetails. + The OCID of the image used to boot the node. + + + :param image_id: The image_id of this NodeSourceViaImageDetails. + :type: str + """ + self._image_id = image_id + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/container_engine/models/node_source_via_image_option.py b/src/oci/container_engine/models/node_source_via_image_option.py new file mode 100644 index 0000000000..d429171450 --- /dev/null +++ b/src/oci/container_engine/models/node_source_via_image_option.py @@ -0,0 +1,86 @@ +# coding: utf-8 +# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. + +from .node_source_option import NodeSourceOption +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class NodeSourceViaImageOption(NodeSourceOption): + """ + An image can be specified as the source of nodes when launching a node pool using the `nodeSourceDetails` object. + """ + + def __init__(self, **kwargs): + """ + Initializes a new NodeSourceViaImageOption object with values from keyword arguments. The default value of the :py:attr:`~oci.container_engine.models.NodeSourceViaImageOption.source_type` attribute + of this class is ``IMAGE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param source_type: + The value to assign to the source_type property of this NodeSourceViaImageOption. + Allowed values for this property are: "IMAGE" + :type source_type: str + + :param source_name: + The value to assign to the source_name property of this NodeSourceViaImageOption. + :type source_name: str + + :param image_id: + The value to assign to the image_id property of this NodeSourceViaImageOption. + :type image_id: str + + """ + self.swagger_types = { + 'source_type': 'str', + 'source_name': 'str', + 'image_id': 'str' + } + + self.attribute_map = { + 'source_type': 'sourceType', + 'source_name': 'sourceName', + 'image_id': 'imageId' + } + + self._source_type = None + self._source_name = None + self._image_id = None + self._source_type = 'IMAGE' + + @property + def image_id(self): + """ + Gets the image_id of this NodeSourceViaImageOption. + The OCID of the image. + + + :return: The image_id of this NodeSourceViaImageOption. + :rtype: str + """ + return self._image_id + + @image_id.setter + def image_id(self, image_id): + """ + Sets the image_id of this NodeSourceViaImageOption. + The OCID of the image. + + + :param image_id: The image_id of this NodeSourceViaImageOption. + :type: str + """ + self._image_id = image_id + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/core/blockstorage_client.py b/src/oci/core/blockstorage_client.py index 58f0bd5e8c..3cba38241c 100644 --- a/src/oci/core/blockstorage_client.py +++ b/src/oci/core/blockstorage_client.py @@ -572,6 +572,99 @@ def change_volume_group_compartment(self, volume_group_id, change_volume_group_c header_params=header_params, body=change_volume_group_compartment_details) + def copy_boot_volume_backup(self, boot_volume_backup_id, copy_boot_volume_backup_details, **kwargs): + """ + CreateBootVolumeBackupCopy + Creates a boot volume backup copy in specified region. For general information about volume backups, + see `Overview of Boot Volume Backups`__ + + __ https://docs.cloud.oracle.com/Content/Block/Concepts/bootvolumebackups.htm + + + :param str boot_volume_backup_id: (required) + The OCID of the boot volume backup. + + :param CopyBootVolumeBackupDetails copy_boot_volume_backup_details: (required) + Request to create a cross-region copy of given boot volume backup. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + may be rejected). + + :param str opc_request_id: (optional) + Unique identifier for the request. + If you need to contact Oracle about a particular request, please provide the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.BootVolumeBackup` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/bootVolumeBackups/{bootVolumeBackupId}/actions/copy" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_retry_token", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "copy_boot_volume_backup got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "bootVolumeBackupId": boot_volume_backup_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=copy_boot_volume_backup_details, + response_type="BootVolumeBackup") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=copy_boot_volume_backup_details, + response_type="BootVolumeBackup") + def copy_volume_backup(self, volume_backup_id, copy_volume_backup_details, **kwargs): """ CreateVolumeBackupCopy @@ -980,7 +1073,12 @@ def create_volume_backup(self, create_volume_backup_details, **kwargs): def create_volume_backup_policy(self, create_volume_backup_policy_details, **kwargs): """ CreateVolumeBackupPolicy - Creates a new backup policy for the caller. + Creates a new user defined backup policy. + + For more information about Oracle defined backup policies and user defined backup policies, + see `Policy-Based Backups`__. + + __ https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm :param CreateVolumeBackupPolicyDetails create_volume_backup_policy_details: (required) @@ -1055,13 +1153,13 @@ def create_volume_backup_policy(self, create_volume_backup_policy_details, **kwa def create_volume_backup_policy_assignment(self, create_volume_backup_policy_assignment_details, **kwargs): """ CreateVolumeBackupPolicyAssignment - Assigns a policy to the specified asset, such as a volume. Note that a given asset can - only have one policy assigned to it; if this method is called for an asset that previously - has a different policy assigned, the prior assignment will be silently deleted. + Assigns a volume backup policy to the specified volume. Note that a given volume can + only have one backup policy assigned to it. If this operation is used for a volume that already + has a different backup policy assigned, the prior backup policy will be silently unassigned. :param CreateVolumeBackupPolicyAssignmentDetails create_volume_backup_policy_assignment_details: (required) - Request to assign a specified policy to a particular asset. + Request to assign a specified policy to a particular volume. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -1411,7 +1509,7 @@ def delete_boot_volume_backup(self, boot_volume_backup_id, **kwargs): def delete_boot_volume_kms_key(self, boot_volume_id, **kwargs): """ DeleteBootVolumeKmsKey - Removes the KMS key for the specified boot volume. + Removes the specified boot volume's assigned Key Management encryption key. :param str boot_volume_id: (required) @@ -1635,7 +1733,13 @@ def delete_volume_backup(self, volume_backup_id, **kwargs): def delete_volume_backup_policy(self, policy_id, **kwargs): """ DeleteVolumeBackupPolicy - Deletes the specified scheduled backup policy. + Deletes a user defined backup policy. + For more information about user defined backup policies, + see `Policy-Based Backups`__. + + Avoid entering confidential information. + + __ https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#UserDefinedBackupPolicies :param str policy_id: (required) @@ -1714,7 +1818,7 @@ def delete_volume_backup_policy(self, policy_id, **kwargs): def delete_volume_backup_policy_assignment(self, policy_assignment_id, **kwargs): """ DeleteVolumeBackupPolicyAssignment - Deletes a volume backup policy assignment (i.e. unassigns the policy from an asset). + Deletes a volume backup policy assignment. :param str policy_assignment_id: (required) @@ -1938,7 +2042,7 @@ def delete_volume_group_backup(self, volume_group_backup_id, **kwargs): def delete_volume_kms_key(self, volume_id, **kwargs): """ DeleteVolumeKmsKey - Removes the KMS key for the specified volume. + Removes the specified volume's assigned Key Management encryption key. :param str volume_id: (required) @@ -2139,7 +2243,7 @@ def get_boot_volume_backup(self, boot_volume_backup_id, **kwargs): def get_boot_volume_kms_key(self, boot_volume_id, **kwargs): """ GetBootVolumeKmsKey - Gets the KMS key ID for the specified boot volume. + Gets the Key Management encryption key assigned to the specified boot volume. :param str boot_volume_id: (required) @@ -2406,9 +2510,9 @@ def get_volume_backup_policy(self, policy_id, **kwargs): def get_volume_backup_policy_asset_assignment(self, asset_id, **kwargs): """ GetVolumeBackupPolicyAssetAssignment - Gets the volume backup policy assignment for the specified asset. Note that the - assetId query parameter is required, and that the returned list will contain at most - one item (since any given asset can only have one policy assigned to it). + Gets the volume backup policy assignment for the specified volume. The + `assetId` query parameter is required, and the returned list will contain at most + one item, since volume can only have one volume backup policy assigned at a time. :param str asset_id: (required) @@ -2686,7 +2790,7 @@ def get_volume_group_backup(self, volume_group_backup_id, **kwargs): def get_volume_kms_key(self, volume_id, **kwargs): """ GetVolumeKmsKey - Gets the KMS key ID for the specified volume. + Gets the Key Management encryption key assigned to the specified volume. :param str volume_id: (required) @@ -2791,6 +2895,9 @@ def list_boot_volume_backups(self, compartment_id, **kwargs): :param str display_name: (optional) A filter to return only resources that match the given display name exactly. + :param str source_boot_volume_backup_id: (optional) + A filter to return only resources that originated from the given source boot volume backup. + :param str sort_by: (optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME @@ -2835,6 +2942,7 @@ def list_boot_volume_backups(self, compartment_id, **kwargs): "limit", "page", "display_name", + "source_boot_volume_backup_id", "sort_by", "sort_order", "lifecycle_state" @@ -2871,6 +2979,7 @@ def list_boot_volume_backups(self, compartment_id, **kwargs): "limit": kwargs.get("limit", missing), "page": kwargs.get("page", missing), "displayName": kwargs.get("display_name", missing), + "sourceBootVolumeBackupId": kwargs.get("source_boot_volume_backup_id", missing), "sortBy": kwargs.get("sort_by", missing), "sortOrder": kwargs.get("sort_order", missing), "lifecycleState": kwargs.get("lifecycle_state", missing) @@ -3000,7 +3109,12 @@ def list_boot_volumes(self, availability_domain, compartment_id, **kwargs): def list_volume_backup_policies(self, **kwargs): """ ListVolumeBackupPolicies - Lists all volume backup policies available to the caller. + Lists all the volume backup policies available in the specified compartment. + + For more information about Oracle defined backup policies and user defined backup policies, + see `Policy-Based Backups`__. + + __ https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm :param int limit: (optional) @@ -3020,8 +3134,8 @@ def list_volume_backup_policies(self, **kwargs): __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine :param str compartment_id: (optional) - The OCID of the compartment to list. - If no compartment is specified, list the predefined (Gold, Silver, Bronze) backup policies. + The OCID of the compartment. + If no compartment is specified, the Oracle defined backup policies are listed. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -3827,14 +3941,14 @@ def update_boot_volume_backup(self, boot_volume_backup_id, update_boot_volume_ba def update_boot_volume_kms_key(self, boot_volume_id, update_boot_volume_kms_key_details, **kwargs): """ UpdateBootVolumeKmsKey - Updates the KMS key ID for the specified volume. + Updates the specified volume with a new Key Management master encryption key. :param str boot_volume_id: (required) The OCID of the boot volume. :param UpdateBootVolumeKmsKeyDetails update_boot_volume_kms_key_details: (required) - Updates the KMS key ID for the specified boot volume. + Updates the Key Management master encryption key assigned to the specified boot volume. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` @@ -4069,8 +4183,13 @@ def update_volume_backup(self, volume_backup_id, update_volume_backup_details, * def update_volume_backup_policy(self, policy_id, update_volume_backup_policy_details, **kwargs): """ UpdateVolumeBackupPolicy - Updates a volume backup policy. - Avoid entering confidential information. + Updates a user defined backup policy. + For more information about user defined backup policies, + see `Policy-Based Backups`__. + + Avoid entering confidential information. + + __ https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#UserDefinedBackupPolicies :param str policy_id: (required) @@ -4336,14 +4455,14 @@ def update_volume_group_backup(self, volume_group_backup_id, update_volume_group def update_volume_kms_key(self, volume_id, update_volume_kms_key_details, **kwargs): """ UpdateVolumeKmsKey - Updates the KMS key ID for the specified volume. + Updates the specified volume with a new Key Management master encryption key. :param str volume_id: (required) The OCID of the volume. :param UpdateVolumeKmsKeyDetails update_volume_kms_key_details: (required) - Update the KMS key ID for the specified volume. + Updates the Key Management master encryption key assigned to the specified volume. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` diff --git a/src/oci/core/blockstorage_client_composite_operations.py b/src/oci/core/blockstorage_client_composite_operations.py index 81315c5e70..a9199a140e 100644 --- a/src/oci/core/blockstorage_client_composite_operations.py +++ b/src/oci/core/blockstorage_client_composite_operations.py @@ -26,6 +26,47 @@ def __init__(self, client, work_request_client=None, **kwargs): self.client = client self._work_request_client = work_request_client if work_request_client else oci.work_requests.WorkRequestClient(self.client._config, **self.client._kwargs) + def copy_boot_volume_backup_and_wait_for_state(self, boot_volume_backup_id, copy_boot_volume_backup_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.core.BlockstorageClient.copy_boot_volume_backup` and waits for the :py:class:`~oci.core.models.BootVolumeBackup` acted upon + to enter the given state(s). + + :param str boot_volume_backup_id: (required) + The OCID of the boot volume backup. + + :param CopyBootVolumeBackupDetails copy_boot_volume_backup_details: (required) + Request to create a cross-region copy of given boot volume backup. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.core.models.BootVolumeBackup.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.core.BlockstorageClient.copy_boot_volume_backup` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.copy_boot_volume_backup(boot_volume_backup_id, copy_boot_volume_backup_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_boot_volume_backup(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def copy_volume_backup_and_wait_for_state(self, volume_backup_id, copy_volume_backup_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.core.BlockstorageClient.copy_volume_backup` and waits for the :py:class:`~oci.core.models.VolumeBackup` acted upon diff --git a/src/oci/core/compute_client_composite_operations.py b/src/oci/core/compute_client_composite_operations.py index 460a3118b4..dc8ae2ca75 100644 --- a/src/oci/core/compute_client_composite_operations.py +++ b/src/oci/core/compute_client_composite_operations.py @@ -1128,6 +1128,44 @@ def update_image_and_wait_for_state(self, image_id, update_image_details, wait_f except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def update_instance_and_wait_for_work_request(self, instance_id, update_instance_details, work_request_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.core.ComputeClient.update_instance` and waits for the oci.work_requests.models.WorkRequest + to enter the given state(s). + + :param str instance_id: (required) + The OCID of the instance. + + :param UpdateInstanceDetails update_instance_details: (required) + Update instance fields + + :param list[str] work_request_states: (optional) + An array of work requests states to wait on. These should be valid values for :py:attr:`~oci.work_requests.models.WorkRequest.status` + Default values are termination states: [STATUS_SUCCEEDED, STATUS_FAILED, STATUS_CANCELED] + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.core.ComputeClient.update_instance` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.update_instance(instance_id, update_instance_details, **operation_kwargs) + work_request_states = work_request_states if work_request_states else oci.waiter._WORK_REQUEST_TERMINATION_STATES + lowered_work_request_states = [w.lower() for w in work_request_states] + work_request_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self._work_request_client, + self._work_request_client.get_work_request(work_request_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_work_request_states, + **waiter_kwargs + ) + return waiter_result + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def update_instance_and_wait_for_state(self, instance_id, update_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.core.ComputeClient.update_instance` and waits for the :py:class:`~oci.core.models.Instance` acted upon diff --git a/src/oci/core/compute_management_client.py b/src/oci/core/compute_management_client.py index 13e131830f..85c7b7d269 100644 --- a/src/oci/core/compute_management_client.py +++ b/src/oci/core/compute_management_client.py @@ -93,7 +93,9 @@ def attach_load_balancer(self, instance_pool_id, attach_load_balancer_details, * :param str instance_pool_id: (required) - The OCID of the instance pool. + The `OCID`__ of the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param AttachLoadBalancerDetails attach_load_balancer_details: (required) Load balancer being attached @@ -405,7 +407,9 @@ def change_instance_pool_compartment(self, instance_pool_id, change_instance_poo :param str instance_pool_id: (required) - The OCID of the instance pool. + The `OCID`__ of the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param ChangeInstancePoolCompartmentDetails change_instance_pool_compartment_details: (required) Request to change the compartment of given instance pool. @@ -784,7 +788,9 @@ def detach_load_balancer(self, instance_pool_id, detach_load_balancer_details, * :param str instance_pool_id: (required) - The OCID of the instance pool. + The `OCID`__ of the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param DetachLoadBalancerDetails detach_load_balancer_details: (required) Load balancer being detached @@ -1005,7 +1011,9 @@ def get_instance_pool(self, instance_pool_id, **kwargs): :param str instance_pool_id: (required) - The OCID of the instance pool. + The `OCID`__ of the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -1069,7 +1077,9 @@ def get_instance_pool_load_balancer_attachment(self, instance_pool_id, instance_ :param str instance_pool_id: (required) - The OCID of the instance pool. + The `OCID`__ of the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str instance_pool_load_balancer_attachment_id: (required) The OCID of the load balancer attachment. @@ -1634,7 +1644,9 @@ def list_instance_pool_instances(self, compartment_id, instance_pool_id, **kwarg __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str instance_pool_id: (required) - The OCID of the instance pool. + The `OCID`__ of the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str display_name: (optional) A filter to return only resources that match the given display name exactly. @@ -1909,7 +1921,9 @@ def reset_instance_pool(self, instance_pool_id, **kwargs): :param str instance_pool_id: (required) - The OCID of the instance pool. + The `OCID`__ of the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -1996,7 +2010,9 @@ def softreset_instance_pool(self, instance_pool_id, **kwargs): :param str instance_pool_id: (required) - The OCID of the instance pool. + The `OCID`__ of the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -2083,7 +2099,9 @@ def start_instance_pool(self, instance_pool_id, **kwargs): :param str instance_pool_id: (required) - The OCID of the instance pool. + The `OCID`__ of the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -2170,7 +2188,9 @@ def stop_instance_pool(self, instance_pool_id, **kwargs): :param str instance_pool_id: (required) - The OCID of the instance pool. + The `OCID`__ of the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -2334,7 +2354,9 @@ def terminate_instance_pool(self, instance_pool_id, **kwargs): :param str instance_pool_id: (required) - The OCID of the instance pool. + The `OCID`__ of the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` @@ -2588,11 +2610,14 @@ def update_instance_pool(self, instance_pool_id, update_instance_pool_details, * """ UpdateInstancePool Update the specified instance pool. + The OCID of the instance pool remains the same. :param str instance_pool_id: (required) - The OCID of the instance pool. + The `OCID`__ of the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param UpdateInstancePoolDetails update_instance_pool_details: (required) Update instance pool configuration diff --git a/src/oci/core/compute_management_client_composite_operations.py b/src/oci/core/compute_management_client_composite_operations.py index 4068a9d68b..6b604d2b8e 100644 --- a/src/oci/core/compute_management_client_composite_operations.py +++ b/src/oci/core/compute_management_client_composite_operations.py @@ -32,7 +32,9 @@ def attach_load_balancer_and_wait_for_state(self, instance_pool_id, attach_load_ to enter the given state(s). :param str instance_pool_id: (required) - The OCID of the instance pool. + The `OCID`__ of the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param AttachLoadBalancerDetails attach_load_balancer_details: (required) Load balancer being attached @@ -184,7 +186,9 @@ def detach_load_balancer_and_wait_for_state(self, instance_pool_id, detach_load_ to enter the given state(s). :param str instance_pool_id: (required) - The OCID of the instance pool. + The `OCID`__ of the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param DetachLoadBalancerDetails detach_load_balancer_details: (required) Load balancer being detached @@ -263,7 +267,9 @@ def reset_instance_pool_and_wait_for_state(self, instance_pool_id, wait_for_stat to enter the given state(s). :param str instance_pool_id: (required) - The OCID of the instance pool. + The `OCID`__ of the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.core.models.InstancePool.lifecycle_state` @@ -301,7 +307,9 @@ def softreset_instance_pool_and_wait_for_state(self, instance_pool_id, wait_for_ to enter the given state(s). :param str instance_pool_id: (required) - The OCID of the instance pool. + The `OCID`__ of the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.core.models.InstancePool.lifecycle_state` @@ -339,7 +347,9 @@ def start_instance_pool_and_wait_for_state(self, instance_pool_id, wait_for_stat to enter the given state(s). :param str instance_pool_id: (required) - The OCID of the instance pool. + The `OCID`__ of the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.core.models.InstancePool.lifecycle_state` @@ -377,7 +387,9 @@ def stop_instance_pool_and_wait_for_state(self, instance_pool_id, wait_for_state to enter the given state(s). :param str instance_pool_id: (required) - The OCID of the instance pool. + The `OCID`__ of the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.core.models.InstancePool.lifecycle_state` @@ -452,7 +464,9 @@ def terminate_instance_pool_and_wait_for_state(self, instance_pool_id, wait_for_ to enter the given state(s). :param str instance_pool_id: (required) - The OCID of the instance pool. + The `OCID`__ of the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.core.models.InstancePool.lifecycle_state` @@ -542,7 +556,9 @@ def update_instance_pool_and_wait_for_state(self, instance_pool_id, update_insta to enter the given state(s). :param str instance_pool_id: (required) - The OCID of the instance pool. + The `OCID`__ of the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param UpdateInstancePoolDetails update_instance_pool_details: (required) Update instance pool configuration diff --git a/src/oci/core/models/__init__.py b/src/oci/core/models/__init__.py index e96cfa720e..8c1cc2ab1d 100644 --- a/src/oci/core/models/__init__.py +++ b/src/oci/core/models/__init__.py @@ -69,6 +69,7 @@ from .connect_local_peering_gateways_details import ConnectLocalPeeringGatewaysDetails from .connect_remote_peering_connections_details import ConnectRemotePeeringConnectionsDetails from .console_history import ConsoleHistory +from .copy_boot_volume_backup_details import CopyBootVolumeBackupDetails from .copy_volume_backup_details import CopyVolumeBackupDetails from .cpe import Cpe from .create_app_catalog_subscription_details import CreateAppCatalogSubscriptionDetails @@ -357,6 +358,7 @@ "ConnectLocalPeeringGatewaysDetails": ConnectLocalPeeringGatewaysDetails, "ConnectRemotePeeringConnectionsDetails": ConnectRemotePeeringConnectionsDetails, "ConsoleHistory": ConsoleHistory, + "CopyBootVolumeBackupDetails": CopyBootVolumeBackupDetails, "CopyVolumeBackupDetails": CopyVolumeBackupDetails, "Cpe": Cpe, "CreateAppCatalogSubscriptionDetails": CreateAppCatalogSubscriptionDetails, diff --git a/src/oci/core/models/attach_load_balancer_details.py b/src/oci/core/models/attach_load_balancer_details.py index 5104d81c99..00989f75dc 100644 --- a/src/oci/core/models/attach_load_balancer_details.py +++ b/src/oci/core/models/attach_load_balancer_details.py @@ -57,7 +57,9 @@ def __init__(self, **kwargs): def load_balancer_id(self): """ **[Required]** Gets the load_balancer_id of this AttachLoadBalancerDetails. - The OCID of the load balancer to attach to the instance pool. + The `OCID`__ of the load balancer to attach to the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The load_balancer_id of this AttachLoadBalancerDetails. @@ -69,7 +71,9 @@ def load_balancer_id(self): def load_balancer_id(self, load_balancer_id): """ Sets the load_balancer_id of this AttachLoadBalancerDetails. - The OCID of the load balancer to attach to the instance pool. + The `OCID`__ of the load balancer to attach to the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param load_balancer_id: The load_balancer_id of this AttachLoadBalancerDetails. diff --git a/src/oci/core/models/boot_volume.py b/src/oci/core/models/boot_volume.py index 5b377b81e2..987d9999d0 100644 --- a/src/oci/core/models/boot_volume.py +++ b/src/oci/core/models/boot_volume.py @@ -429,7 +429,17 @@ def is_hydrated(self, is_hydrated): def vpus_per_gb(self): """ Gets the vpus_per_gb of this BootVolume. - The number of Volume Performance Units that will be applied to this boot volume per GB. + The number of volume performance units (VPUs) that will be applied to this boot volume per GB, + representing the Block Volume service's elastic performance options. + See `Block Volume Elastic Performance`__ for more information. + + Allowed values: + + * `10`: Represents Balanced option. + + * `20`: Represents Higher Performance option. + + __ https://docs.cloud.oracle.com/Content/Block/Concepts/blockvolumeelasticperformance.htm :return: The vpus_per_gb of this BootVolume. @@ -441,7 +451,17 @@ def vpus_per_gb(self): def vpus_per_gb(self, vpus_per_gb): """ Sets the vpus_per_gb of this BootVolume. - The number of Volume Performance Units that will be applied to this boot volume per GB. + The number of volume performance units (VPUs) that will be applied to this boot volume per GB, + representing the Block Volume service's elastic performance options. + See `Block Volume Elastic Performance`__ for more information. + + Allowed values: + + * `10`: Represents Balanced option. + + * `20`: Represents Higher Performance option. + + __ https://docs.cloud.oracle.com/Content/Block/Concepts/blockvolumeelasticperformance.htm :param vpus_per_gb: The vpus_per_gb of this BootVolume. @@ -607,7 +627,7 @@ def volume_group_id(self, volume_group_id): def kms_key_id(self): """ Gets the kms_key_id of this BootVolume. - The OCID of the KMS key which is the master encryption key for the boot volume. + The OCID of the Key Management master encryption key assigned to the boot volume. :return: The kms_key_id of this BootVolume. @@ -619,7 +639,7 @@ def kms_key_id(self): def kms_key_id(self, kms_key_id): """ Sets the kms_key_id of this BootVolume. - The OCID of the KMS key which is the master encryption key for the boot volume. + The OCID of the Key Management master encryption key assigned to the boot volume. :param kms_key_id: The kms_key_id of this BootVolume. diff --git a/src/oci/core/models/boot_volume_backup.py b/src/oci/core/models/boot_volume_backup.py index 06654ce72d..0c3f315c42 100644 --- a/src/oci/core/models/boot_volume_backup.py +++ b/src/oci/core/models/boot_volume_backup.py @@ -119,6 +119,10 @@ def __init__(self, **kwargs): The value to assign to the size_in_gbs property of this BootVolumeBackup. :type size_in_gbs: int + :param source_boot_volume_backup_id: + The value to assign to the source_boot_volume_backup_id property of this BootVolumeBackup. + :type source_boot_volume_backup_id: str + :param source_type: The value to assign to the source_type property of this BootVolumeBackup. Allowed values for this property are: "MANUAL", "SCHEDULED", 'UNKNOWN_ENUM_VALUE'. @@ -157,6 +161,7 @@ def __init__(self, **kwargs): 'kms_key_id': 'str', 'lifecycle_state': 'str', 'size_in_gbs': 'int', + 'source_boot_volume_backup_id': 'str', 'source_type': 'str', 'time_created': 'datetime', 'time_request_received': 'datetime', @@ -177,6 +182,7 @@ def __init__(self, **kwargs): 'kms_key_id': 'kmsKeyId', 'lifecycle_state': 'lifecycleState', 'size_in_gbs': 'sizeInGBs', + 'source_boot_volume_backup_id': 'sourceBootVolumeBackupId', 'source_type': 'sourceType', 'time_created': 'timeCreated', 'time_request_received': 'timeRequestReceived', @@ -196,6 +202,7 @@ def __init__(self, **kwargs): self._kms_key_id = None self._lifecycle_state = None self._size_in_gbs = None + self._source_boot_volume_backup_id = None self._source_type = None self._time_created = None self._time_request_received = None @@ -454,7 +461,7 @@ def image_id(self, image_id): def kms_key_id(self): """ Gets the kms_key_id of this BootVolumeBackup. - The OCID of the KMS key which is the master encryption key for the boot volume backup. + The OCID of the Key Management master encryption assigned to the boot volume backup. For more information about the Key Management service and encryption keys, see `Overview of Key Management`__ and `Using Keys`__. @@ -472,7 +479,7 @@ def kms_key_id(self): def kms_key_id(self, kms_key_id): """ Sets the kms_key_id of this BootVolumeBackup. - The OCID of the KMS key which is the master encryption key for the boot volume backup. + The OCID of the Key Management master encryption assigned to the boot volume backup. For more information about the Key Management service and encryption keys, see `Overview of Key Management`__ and `Using Keys`__. @@ -540,6 +547,30 @@ def size_in_gbs(self, size_in_gbs): """ self._size_in_gbs = size_in_gbs + @property + def source_boot_volume_backup_id(self): + """ + Gets the source_boot_volume_backup_id of this BootVolumeBackup. + The OCID of the source boot volume backup. + + + :return: The source_boot_volume_backup_id of this BootVolumeBackup. + :rtype: str + """ + return self._source_boot_volume_backup_id + + @source_boot_volume_backup_id.setter + def source_boot_volume_backup_id(self, source_boot_volume_backup_id): + """ + Sets the source_boot_volume_backup_id of this BootVolumeBackup. + The OCID of the source boot volume backup. + + + :param source_boot_volume_backup_id: The source_boot_volume_backup_id of this BootVolumeBackup. + :type: str + """ + self._source_boot_volume_backup_id = source_boot_volume_backup_id + @property def source_type(self): """ diff --git a/src/oci/core/models/boot_volume_kms_key.py b/src/oci/core/models/boot_volume_kms_key.py index c1d34cfa0e..59a7b1d03f 100644 --- a/src/oci/core/models/boot_volume_kms_key.py +++ b/src/oci/core/models/boot_volume_kms_key.py @@ -9,7 +9,7 @@ @init_model_state_from_kwargs class BootVolumeKmsKey(object): """ - Kms key id associated with this volume. + The Key Management master encryption key associated with this volume. """ def __init__(self, **kwargs): @@ -36,7 +36,7 @@ def __init__(self, **kwargs): def kms_key_id(self): """ Gets the kms_key_id of this BootVolumeKmsKey. - The OCID of the KMS key associated with this volume. If volume is not using KMS, then the `kmsKeyId` will be a null string. + The OCID of the Key Management key assigned to this volume. If the volume is not using Key Management, then the `kmsKeyId` will be a null string. :return: The kms_key_id of this BootVolumeKmsKey. @@ -48,7 +48,7 @@ def kms_key_id(self): def kms_key_id(self, kms_key_id): """ Sets the kms_key_id of this BootVolumeKmsKey. - The OCID of the KMS key associated with this volume. If volume is not using KMS, then the `kmsKeyId` will be a null string. + The OCID of the Key Management key assigned to this volume. If the volume is not using Key Management, then the `kmsKeyId` will be a null string. :param kms_key_id: The kms_key_id of this BootVolumeKmsKey. diff --git a/src/oci/core/models/copy_boot_volume_backup_details.py b/src/oci/core/models/copy_boot_volume_backup_details.py new file mode 100644 index 0000000000..8636483fbd --- /dev/null +++ b/src/oci/core/models/copy_boot_volume_backup_details.py @@ -0,0 +1,157 @@ +# coding: utf-8 +# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CopyBootVolumeBackupDetails(object): + """ + CopyBootVolumeBackupDetails model. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CopyBootVolumeBackupDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param destination_region: + The value to assign to the destination_region property of this CopyBootVolumeBackupDetails. + :type destination_region: str + + :param display_name: + The value to assign to the display_name property of this CopyBootVolumeBackupDetails. + :type display_name: str + + :param kms_key_id: + The value to assign to the kms_key_id property of this CopyBootVolumeBackupDetails. + :type kms_key_id: str + + """ + self.swagger_types = { + 'destination_region': 'str', + 'display_name': 'str', + 'kms_key_id': 'str' + } + + self.attribute_map = { + 'destination_region': 'destinationRegion', + 'display_name': 'displayName', + 'kms_key_id': 'kmsKeyId' + } + + self._destination_region = None + self._display_name = None + self._kms_key_id = None + + @property + def destination_region(self): + """ + **[Required]** Gets the destination_region of this CopyBootVolumeBackupDetails. + The name of the destination region. + + Example: `us-ashburn-1` + + + :return: The destination_region of this CopyBootVolumeBackupDetails. + :rtype: str + """ + return self._destination_region + + @destination_region.setter + def destination_region(self, destination_region): + """ + Sets the destination_region of this CopyBootVolumeBackupDetails. + The name of the destination region. + + Example: `us-ashburn-1` + + + :param destination_region: The destination_region of this CopyBootVolumeBackupDetails. + :type: str + """ + self._destination_region = destination_region + + @property + def display_name(self): + """ + Gets the display_name of this CopyBootVolumeBackupDetails. + A user-friendly name for the boot volume backup. Does not have to be unique and it's changeable. + Avoid entering confidential information. + + + :return: The display_name of this CopyBootVolumeBackupDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CopyBootVolumeBackupDetails. + A user-friendly name for the boot volume backup. Does not have to be unique and it's changeable. + Avoid entering confidential information. + + + :param display_name: The display_name of this CopyBootVolumeBackupDetails. + :type: str + """ + self._display_name = display_name + + @property + def kms_key_id(self): + """ + Gets the kms_key_id of this CopyBootVolumeBackupDetails. + The OCID of the Key Management key in the destination region which will be the master encryption key + for the copied boot volume backup. If you do not specify this attribute the boot volume backup + will be encrypted with the Oracle-provided encryption key when it is copied to the destination region. + + + For more information about the Key Management service and encryption keys, see + `Overview of Key Management`__ and + `Using Keys`__. + + __ https://docs.cloud.oracle.com/Content/KeyManagement/Concepts/keyoverview.htm + __ https://docs.cloud.oracle.com/Content/KeyManagement/Tasks/usingkeys.htm + + + :return: The kms_key_id of this CopyBootVolumeBackupDetails. + :rtype: str + """ + return self._kms_key_id + + @kms_key_id.setter + def kms_key_id(self, kms_key_id): + """ + Sets the kms_key_id of this CopyBootVolumeBackupDetails. + The OCID of the Key Management key in the destination region which will be the master encryption key + for the copied boot volume backup. If you do not specify this attribute the boot volume backup + will be encrypted with the Oracle-provided encryption key when it is copied to the destination region. + + + For more information about the Key Management service and encryption keys, see + `Overview of Key Management`__ and + `Using Keys`__. + + __ https://docs.cloud.oracle.com/Content/KeyManagement/Concepts/keyoverview.htm + __ https://docs.cloud.oracle.com/Content/KeyManagement/Tasks/usingkeys.htm + + + :param kms_key_id: The kms_key_id of this CopyBootVolumeBackupDetails. + :type: str + """ + self._kms_key_id = kms_key_id + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/core/models/copy_volume_backup_details.py b/src/oci/core/models/copy_volume_backup_details.py index f6fc69f425..f058e10b19 100644 --- a/src/oci/core/models/copy_volume_backup_details.py +++ b/src/oci/core/models/copy_volume_backup_details.py @@ -104,7 +104,7 @@ def display_name(self, display_name): def kms_key_id(self): """ Gets the kms_key_id of this CopyVolumeBackupDetails. - The OCID of the KMS key in the destination region which will be the master encryption key + The OCID of the Key Management key in the destination region which will be the master encryption key for the copied volume backup. If you do not specify this attribute the volume backup will be encrypted with the Oracle-provided encryption key when it is copied to the destination region. @@ -127,7 +127,7 @@ def kms_key_id(self): def kms_key_id(self, kms_key_id): """ Sets the kms_key_id of this CopyVolumeBackupDetails. - The OCID of the KMS key in the destination region which will be the master encryption key + The OCID of the Key Management key in the destination region which will be the master encryption key for the copied volume backup. If you do not specify this attribute the volume backup will be encrypted with the Oracle-provided encryption key when it is copied to the destination region. diff --git a/src/oci/core/models/create_app_catalog_subscription_details.py b/src/oci/core/models/create_app_catalog_subscription_details.py index de0e4f9e28..edca26117b 100644 --- a/src/oci/core/models/create_app_catalog_subscription_details.py +++ b/src/oci/core/models/create_app_catalog_subscription_details.py @@ -77,7 +77,7 @@ def __init__(self, **kwargs): @property def compartment_id(self): """ - Gets the compartment_id of this CreateAppCatalogSubscriptionDetails. + **[Required]** Gets the compartment_id of this CreateAppCatalogSubscriptionDetails. The compartmentID for the subscription. @@ -101,7 +101,7 @@ def compartment_id(self, compartment_id): @property def listing_id(self): """ - Gets the listing_id of this CreateAppCatalogSubscriptionDetails. + **[Required]** Gets the listing_id of this CreateAppCatalogSubscriptionDetails. The OCID of the listing. @@ -125,7 +125,7 @@ def listing_id(self, listing_id): @property def listing_resource_version(self): """ - Gets the listing_resource_version of this CreateAppCatalogSubscriptionDetails. + **[Required]** Gets the listing_resource_version of this CreateAppCatalogSubscriptionDetails. Listing resource version. @@ -149,7 +149,7 @@ def listing_resource_version(self, listing_resource_version): @property def oracle_terms_of_use_link(self): """ - Gets the oracle_terms_of_use_link of this CreateAppCatalogSubscriptionDetails. + **[Required]** Gets the oracle_terms_of_use_link of this CreateAppCatalogSubscriptionDetails. Oracle TOU link @@ -197,7 +197,7 @@ def eula_link(self, eula_link): @property def time_retrieved(self): """ - Gets the time_retrieved of this CreateAppCatalogSubscriptionDetails. + **[Required]** Gets the time_retrieved of this CreateAppCatalogSubscriptionDetails. Date and time the agreements were retrieved, in RFC3339 format. Example: `2018-03-20T12:32:53.532Z` @@ -223,7 +223,7 @@ def time_retrieved(self, time_retrieved): @property def signature(self): """ - Gets the signature of this CreateAppCatalogSubscriptionDetails. + **[Required]** Gets the signature of this CreateAppCatalogSubscriptionDetails. A generated signature for this listing resource version retrieved the agreements API. diff --git a/src/oci/core/models/create_boot_volume_details.py b/src/oci/core/models/create_boot_volume_details.py index 6b9bce262d..b30d954476 100644 --- a/src/oci/core/models/create_boot_volume_details.py +++ b/src/oci/core/models/create_boot_volume_details.py @@ -271,7 +271,8 @@ def freeform_tags(self, freeform_tags): def kms_key_id(self): """ Gets the kms_key_id of this CreateBootVolumeDetails. - The OCID of the KMS key to be used as the master encryption key for the boot volume. + The OCID of the Key Management key to assign as the master encryption key + for the boot volume. :return: The kms_key_id of this CreateBootVolumeDetails. @@ -283,7 +284,8 @@ def kms_key_id(self): def kms_key_id(self, kms_key_id): """ Sets the kms_key_id of this CreateBootVolumeDetails. - The OCID of the KMS key to be used as the master encryption key for the boot volume. + The OCID of the Key Management key to assign as the master encryption key + for the boot volume. :param kms_key_id: The kms_key_id of this CreateBootVolumeDetails. @@ -319,7 +321,17 @@ def size_in_gbs(self, size_in_gbs): def vpus_per_gb(self): """ Gets the vpus_per_gb of this CreateBootVolumeDetails. - The number of Volume Performance Units that will be applied to this boot volume per GB. + The number of volume performance units (VPUs) that will be applied to this volume per GB, + representing the Block Volume service's elastic performance options. + See `Block Volume Elastic Performance`__ for more information. + + Allowed values: + + * `10`: Represents Balanced option. + + * `20`: Represents Higher Performance option. + + __ https://docs.cloud.oracle.com/Content/Block/Concepts/blockvolumeelasticperformance.htm :return: The vpus_per_gb of this CreateBootVolumeDetails. @@ -331,7 +343,17 @@ def vpus_per_gb(self): def vpus_per_gb(self, vpus_per_gb): """ Sets the vpus_per_gb of this CreateBootVolumeDetails. - The number of Volume Performance Units that will be applied to this boot volume per GB. + The number of volume performance units (VPUs) that will be applied to this volume per GB, + representing the Block Volume service's elastic performance options. + See `Block Volume Elastic Performance`__ for more information. + + Allowed values: + + * `10`: Represents Balanced option. + + * `20`: Represents Higher Performance option. + + __ https://docs.cloud.oracle.com/Content/Block/Concepts/blockvolumeelasticperformance.htm :param vpus_per_gb: The vpus_per_gb of this CreateBootVolumeDetails. diff --git a/src/oci/core/models/create_instance_pool_details.py b/src/oci/core/models/create_instance_pool_details.py index 1337037cdf..09c1943231 100644 --- a/src/oci/core/models/create_instance_pool_details.py +++ b/src/oci/core/models/create_instance_pool_details.py @@ -85,7 +85,9 @@ def __init__(self, **kwargs): def compartment_id(self): """ **[Required]** Gets the compartment_id of this CreateInstancePoolDetails. - The OCID of the compartment containing the instance pool + The `OCID`__ of the compartment containing the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this CreateInstancePoolDetails. @@ -97,7 +99,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this CreateInstancePoolDetails. - The OCID of the compartment containing the instance pool + The `OCID`__ of the compartment containing the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this CreateInstancePoolDetails. @@ -203,7 +207,10 @@ def freeform_tags(self, freeform_tags): def instance_configuration_id(self): """ **[Required]** Gets the instance_configuration_id of this CreateInstancePoolDetails. - The OCID of the instance configuration associated with the instance pool. + The `OCID`__ of the instance configuration associated + with the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The instance_configuration_id of this CreateInstancePoolDetails. @@ -215,7 +222,10 @@ def instance_configuration_id(self): def instance_configuration_id(self, instance_configuration_id): """ Sets the instance_configuration_id of this CreateInstancePoolDetails. - The OCID of the instance configuration associated with the instance pool. + The `OCID`__ of the instance configuration associated + with the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param instance_configuration_id: The instance_configuration_id of this CreateInstancePoolDetails. diff --git a/src/oci/core/models/create_instance_pool_placement_configuration_details.py b/src/oci/core/models/create_instance_pool_placement_configuration_details.py index 789d9d3f16..21322de7ce 100644 --- a/src/oci/core/models/create_instance_pool_placement_configuration_details.py +++ b/src/oci/core/models/create_instance_pool_placement_configuration_details.py @@ -58,6 +58,7 @@ def availability_domain(self): """ **[Required]** Gets the availability_domain of this CreateInstancePoolPlacementConfigurationDetails. The availability domain to place instances. + Example: `Uocm:PHX-AD-1` @@ -71,6 +72,7 @@ def availability_domain(self, availability_domain): """ Sets the availability_domain of this CreateInstancePoolPlacementConfigurationDetails. The availability domain to place instances. + Example: `Uocm:PHX-AD-1` @@ -85,6 +87,19 @@ def fault_domains(self): Gets the fault_domains of this CreateInstancePoolPlacementConfigurationDetails. The fault domains to place instances. + If you don't provide any values, the system makes a best effort to distribute + instances across all fault domains based on capacity. + + To distribute the instances evenly across selected fault domains, provide a + set of fault domains. For example, you might want instances to be evenly + distributed if your applications require high availability. + + To get a list of fault domains, use the + :func:`list_fault_domains` operation + in the Identity and Access Management Service API. + + Example: `[FAULT-DOMAIN-1, FAULT-DOMAIN-2, FAULT-DOMAIN-3]` + :return: The fault_domains of this CreateInstancePoolPlacementConfigurationDetails. :rtype: list[str] @@ -97,6 +112,19 @@ def fault_domains(self, fault_domains): Sets the fault_domains of this CreateInstancePoolPlacementConfigurationDetails. The fault domains to place instances. + If you don't provide any values, the system makes a best effort to distribute + instances across all fault domains based on capacity. + + To distribute the instances evenly across selected fault domains, provide a + set of fault domains. For example, you might want instances to be evenly + distributed if your applications require high availability. + + To get a list of fault domains, use the + :func:`list_fault_domains` operation + in the Identity and Access Management Service API. + + Example: `[FAULT-DOMAIN-1, FAULT-DOMAIN-2, FAULT-DOMAIN-3]` + :param fault_domains: The fault_domains of this CreateInstancePoolPlacementConfigurationDetails. :type: list[str] @@ -107,7 +135,9 @@ def fault_domains(self, fault_domains): def primary_subnet_id(self): """ **[Required]** Gets the primary_subnet_id of this CreateInstancePoolPlacementConfigurationDetails. - The OCID of the primary subnet to place instances. + The `OCID`__ of the primary subnet to place instances. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The primary_subnet_id of this CreateInstancePoolPlacementConfigurationDetails. @@ -119,7 +149,9 @@ def primary_subnet_id(self): def primary_subnet_id(self, primary_subnet_id): """ Sets the primary_subnet_id of this CreateInstancePoolPlacementConfigurationDetails. - The OCID of the primary subnet to place instances. + The `OCID`__ of the primary subnet to place instances. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param primary_subnet_id: The primary_subnet_id of this CreateInstancePoolPlacementConfigurationDetails. 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 1b4a204ed1..ca89e0b32a 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 @@ -43,7 +43,7 @@ def __init__(self, **kwargs): def asset_id(self): """ **[Required]** Gets the asset_id of this CreateVolumeBackupPolicyAssignmentDetails. - The OCID of the asset (e.g. a volume) to which to assign the policy. + The OCID of the volume to assign the policy to. :return: The asset_id of this CreateVolumeBackupPolicyAssignmentDetails. @@ -55,7 +55,7 @@ def asset_id(self): def asset_id(self, asset_id): """ Sets the asset_id of this CreateVolumeBackupPolicyAssignmentDetails. - The OCID of the asset (e.g. a volume) to which to assign the policy. + The OCID of the volume to assign the policy to. :param asset_id: The asset_id of this CreateVolumeBackupPolicyAssignmentDetails. @@ -67,7 +67,7 @@ def asset_id(self, asset_id): def policy_id(self): """ **[Required]** Gets the policy_id of this CreateVolumeBackupPolicyAssignmentDetails. - The OCID of the volume backup policy to assign to an asset. + The OCID of the volume backup policy to assign to the volume. :return: The policy_id of this CreateVolumeBackupPolicyAssignmentDetails. @@ -79,7 +79,7 @@ def policy_id(self): def policy_id(self, policy_id): """ Sets the policy_id of this CreateVolumeBackupPolicyAssignmentDetails. - The OCID of the volume backup policy to assign to an asset. + The OCID of the volume backup policy to assign to the volume. :param policy_id: The policy_id of this CreateVolumeBackupPolicyAssignmentDetails. diff --git a/src/oci/core/models/create_volume_backup_policy_details.py b/src/oci/core/models/create_volume_backup_policy_details.py index 7eaedfb987..a791e703c8 100644 --- a/src/oci/core/models/create_volume_backup_policy_details.py +++ b/src/oci/core/models/create_volume_backup_policy_details.py @@ -9,7 +9,13 @@ @init_model_state_from_kwargs class CreateVolumeBackupPolicyDetails(object): """ - Contains properties for a scheduled backup policy. + Specifies the properties for creating user defined backup policy. + For more information about user defined backup policies, + see `User Defined Policies`__ in + `Policy-Based Backups`__. + + __ https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#UserDefinedBackupPolicies + __ https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm """ def __init__(self, **kwargs): @@ -64,7 +70,7 @@ def __init__(self, **kwargs): def compartment_id(self): """ **[Required]** Gets the compartment_id of this CreateVolumeBackupPolicyDetails. - The OCID of the compartment that contains the backup policy. + The OCID of the compartment. :return: The compartment_id of this CreateVolumeBackupPolicyDetails. @@ -76,7 +82,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this CreateVolumeBackupPolicyDetails. - The OCID of the compartment that contains the backup policy. + The OCID of the compartment. :param compartment_id: The compartment_id of this CreateVolumeBackupPolicyDetails. @@ -114,7 +120,12 @@ def display_name(self, display_name): def schedules(self): """ Gets the schedules of this CreateVolumeBackupPolicyDetails. - The collection of schedules that this policy will apply. + The collection of schedules for the volume backup policy. See + see `Schedules`__ in + `Policy-Based Backups`__ for more information. + + __ https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#schedules + __ https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm :return: The schedules of this CreateVolumeBackupPolicyDetails. @@ -126,7 +137,12 @@ def schedules(self): def schedules(self, schedules): """ Sets the schedules of this CreateVolumeBackupPolicyDetails. - The collection of schedules that this policy will apply. + The collection of schedules for the volume backup policy. See + see `Schedules`__ in + `Policy-Based Backups`__ for more information. + + __ https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#schedules + __ https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm :param schedules: The schedules of this CreateVolumeBackupPolicyDetails. diff --git a/src/oci/core/models/create_volume_details.py b/src/oci/core/models/create_volume_details.py index 7c164aed34..32c2603572 100644 --- a/src/oci/core/models/create_volume_details.py +++ b/src/oci/core/models/create_volume_details.py @@ -285,7 +285,8 @@ def freeform_tags(self, freeform_tags): def kms_key_id(self): """ Gets the kms_key_id of this CreateVolumeDetails. - The OCID of the KMS key to be used as the master encryption key for the volume. + The OCID of the Key Management key to assign as the master encryption key + for the volume. :return: The kms_key_id of this CreateVolumeDetails. @@ -297,7 +298,8 @@ def kms_key_id(self): def kms_key_id(self, kms_key_id): """ Sets the kms_key_id of this CreateVolumeDetails. - The OCID of the KMS key to be used as the master encryption key for the volume. + The OCID of the Key Management key to assign as the master encryption key + for the volume. :param kms_key_id: The kms_key_id of this CreateVolumeDetails. @@ -309,7 +311,19 @@ def kms_key_id(self, kms_key_id): def vpus_per_gb(self): """ Gets the vpus_per_gb of this CreateVolumeDetails. - The number of Volume Performance Units that will be applied to this volume per GB. + The number of volume performance units (VPUs) that will be applied to this volume per GB, + representing the Block Volume service's elastic performance options. + See `Block Volume Elastic Performance`__ for more information. + + Allowed values: + + * `0`: Represents Lower Cost option. + + * `10`: Represents Balanced option. + + * `20`: Represents Higher Performance option. + + __ https://docs.cloud.oracle.com/Content/Block/Concepts/blockvolumeelasticperformance.htm :return: The vpus_per_gb of this CreateVolumeDetails. @@ -321,7 +335,19 @@ def vpus_per_gb(self): def vpus_per_gb(self, vpus_per_gb): """ Sets the vpus_per_gb of this CreateVolumeDetails. - The number of Volume Performance Units that will be applied to this volume per GB. + The number of volume performance units (VPUs) that will be applied to this volume per GB, + representing the Block Volume service's elastic performance options. + See `Block Volume Elastic Performance`__ for more information. + + Allowed values: + + * `0`: Represents Lower Cost option. + + * `10`: Represents Balanced option. + + * `20`: Represents Higher Performance option. + + __ https://docs.cloud.oracle.com/Content/Block/Concepts/blockvolumeelasticperformance.htm :param vpus_per_gb: The vpus_per_gb of this CreateVolumeDetails. diff --git a/src/oci/core/models/instance_agent_config.py b/src/oci/core/models/instance_agent_config.py index bfef496d81..073e4a3778 100644 --- a/src/oci/core/models/instance_agent_config.py +++ b/src/oci/core/models/instance_agent_config.py @@ -21,16 +21,23 @@ def __init__(self, **kwargs): The value to assign to the is_monitoring_disabled property of this InstanceAgentConfig. :type is_monitoring_disabled: bool + :param is_management_disabled: + The value to assign to the is_management_disabled property of this InstanceAgentConfig. + :type is_management_disabled: bool + """ self.swagger_types = { - 'is_monitoring_disabled': 'bool' + 'is_monitoring_disabled': 'bool', + 'is_management_disabled': 'bool' } self.attribute_map = { - 'is_monitoring_disabled': 'isMonitoringDisabled' + 'is_monitoring_disabled': 'isMonitoringDisabled', + 'is_management_disabled': 'isManagementDisabled' } self._is_monitoring_disabled = None + self._is_management_disabled = None @property def is_monitoring_disabled(self): @@ -56,6 +63,30 @@ def is_monitoring_disabled(self, is_monitoring_disabled): """ self._is_monitoring_disabled = is_monitoring_disabled + @property + def is_management_disabled(self): + """ + Gets the is_management_disabled of this InstanceAgentConfig. + Whether the agent running on the instance can run all the available management plugins. + + + :return: The is_management_disabled of this InstanceAgentConfig. + :rtype: bool + """ + return self._is_management_disabled + + @is_management_disabled.setter + def is_management_disabled(self, is_management_disabled): + """ + Sets the is_management_disabled of this InstanceAgentConfig. + Whether the agent running on the instance can run all the available management plugins. + + + :param is_management_disabled: The is_management_disabled of this InstanceAgentConfig. + :type: bool + """ + self._is_management_disabled = is_management_disabled + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/core/models/instance_agent_features.py b/src/oci/core/models/instance_agent_features.py index 5ce424a4a4..e9bc284604 100644 --- a/src/oci/core/models/instance_agent_features.py +++ b/src/oci/core/models/instance_agent_features.py @@ -21,16 +21,23 @@ def __init__(self, **kwargs): The value to assign to the is_monitoring_supported property of this InstanceAgentFeatures. :type is_monitoring_supported: bool + :param is_management_supported: + The value to assign to the is_management_supported property of this InstanceAgentFeatures. + :type is_management_supported: bool + """ self.swagger_types = { - 'is_monitoring_supported': 'bool' + 'is_monitoring_supported': 'bool', + 'is_management_supported': 'bool' } self.attribute_map = { - 'is_monitoring_supported': 'isMonitoringSupported' + 'is_monitoring_supported': 'isMonitoringSupported', + 'is_management_supported': 'isManagementSupported' } self._is_monitoring_supported = None + self._is_management_supported = None @property def is_monitoring_supported(self): @@ -56,6 +63,30 @@ def is_monitoring_supported(self, is_monitoring_supported): """ self._is_monitoring_supported = is_monitoring_supported + @property + def is_management_supported(self): + """ + Gets the is_management_supported of this InstanceAgentFeatures. + Whether the agent running on the instance can run all the available management plugins + + + :return: The is_management_supported of this InstanceAgentFeatures. + :rtype: bool + """ + return self._is_management_supported + + @is_management_supported.setter + def is_management_supported(self, is_management_supported): + """ + Sets the is_management_supported of this InstanceAgentFeatures. + Whether the agent running on the instance can run all the available management plugins + + + :param is_management_supported: The is_management_supported of this InstanceAgentFeatures. + :type: bool + """ + self._is_management_supported = is_management_supported + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/core/models/instance_pool.py b/src/oci/core/models/instance_pool.py index 7182be9bac..c537d64669 100644 --- a/src/oci/core/models/instance_pool.py +++ b/src/oci/core/models/instance_pool.py @@ -144,7 +144,9 @@ def __init__(self, **kwargs): def id(self): """ **[Required]** Gets the id of this InstancePool. - The OCID of the instance pool. + The `OCID`__ of the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The id of this InstancePool. @@ -156,7 +158,9 @@ def id(self): def id(self, id): """ Sets the id of this InstancePool. - The OCID of the instance pool. + The `OCID`__ of the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param id: The id of this InstancePool. @@ -168,7 +172,10 @@ def id(self, id): def compartment_id(self): """ **[Required]** Gets the compartment_id of this InstancePool. - The OCID of the compartment containing the instance pool. + The `OCID`__ of the compartment containing the instance + pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this InstancePool. @@ -180,7 +187,10 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this InstancePool. - The OCID of the compartment containing the instance pool. + The `OCID`__ of the compartment containing the instance + pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this InstancePool. @@ -226,7 +236,7 @@ def defined_tags(self, defined_tags): def display_name(self): """ Gets the display_name of this InstancePool. - The user-friendly name. Does not have to be unique. + The user-friendly name. Does not have to be unique. :return: The display_name of this InstancePool. @@ -238,7 +248,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this InstancePool. - The user-friendly name. Does not have to be unique. + The user-friendly name. Does not have to be unique. :param display_name: The display_name of this InstancePool. @@ -284,7 +294,10 @@ def freeform_tags(self, freeform_tags): def instance_configuration_id(self): """ **[Required]** Gets the instance_configuration_id of this InstancePool. - The OCID of the instance configuration associated with the instance pool. + The `OCID`__ of the instance configuration associated + with the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The instance_configuration_id of this InstancePool. @@ -296,7 +309,10 @@ def instance_configuration_id(self): def instance_configuration_id(self, instance_configuration_id): """ Sets the instance_configuration_id of this InstancePool. - The OCID of the instance configuration associated with the instance pool. + The `OCID`__ of the instance configuration associated + with the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param instance_configuration_id: The instance_configuration_id of this InstancePool. diff --git a/src/oci/core/models/instance_pool_load_balancer_attachment.py b/src/oci/core/models/instance_pool_load_balancer_attachment.py index 68a9585167..3ff013919a 100644 --- a/src/oci/core/models/instance_pool_load_balancer_attachment.py +++ b/src/oci/core/models/instance_pool_load_balancer_attachment.py @@ -96,7 +96,9 @@ def __init__(self, **kwargs): def id(self): """ **[Required]** Gets the id of this InstancePoolLoadBalancerAttachment. - The OCID of the load balancer attachment. + The `OCID`__ of the load balancer attachment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The id of this InstancePoolLoadBalancerAttachment. @@ -108,7 +110,9 @@ def id(self): def id(self, id): """ Sets the id of this InstancePoolLoadBalancerAttachment. - The OCID of the load balancer attachment. + The `OCID`__ of the load balancer attachment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param id: The id of this InstancePoolLoadBalancerAttachment. @@ -120,7 +124,9 @@ def id(self, id): def instance_pool_id(self): """ **[Required]** Gets the instance_pool_id of this InstancePoolLoadBalancerAttachment. - The OCID of the instance pool of the load balancer attachment. + The `OCID`__ of the instance pool of the load balancer attachment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The instance_pool_id of this InstancePoolLoadBalancerAttachment. @@ -132,7 +138,9 @@ def instance_pool_id(self): def instance_pool_id(self, instance_pool_id): """ Sets the instance_pool_id of this InstancePoolLoadBalancerAttachment. - The OCID of the instance pool of the load balancer attachment. + The `OCID`__ of the instance pool of the load balancer attachment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param instance_pool_id: The instance_pool_id of this InstancePoolLoadBalancerAttachment. @@ -144,7 +152,9 @@ def instance_pool_id(self, instance_pool_id): def load_balancer_id(self): """ **[Required]** Gets the load_balancer_id of this InstancePoolLoadBalancerAttachment. - The OCID of the load balancer attached to the instance pool. + The `OCID`__ of the load balancer attached to the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The load_balancer_id of this InstancePoolLoadBalancerAttachment. @@ -156,7 +166,9 @@ def load_balancer_id(self): def load_balancer_id(self, load_balancer_id): """ Sets the load_balancer_id of this InstancePoolLoadBalancerAttachment. - The OCID of the load balancer attached to the instance pool. + The `OCID`__ of the load balancer attached to the instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param load_balancer_id: The load_balancer_id of this InstancePoolLoadBalancerAttachment. diff --git a/src/oci/core/models/instance_pool_placement_configuration.py b/src/oci/core/models/instance_pool_placement_configuration.py index 1e86482a02..82f1f74780 100644 --- a/src/oci/core/models/instance_pool_placement_configuration.py +++ b/src/oci/core/models/instance_pool_placement_configuration.py @@ -58,6 +58,7 @@ def availability_domain(self): """ **[Required]** Gets the availability_domain of this InstancePoolPlacementConfiguration. The availability domain to place instances. + Example: `Uocm:PHX-AD-1` @@ -71,6 +72,7 @@ def availability_domain(self, availability_domain): """ Sets the availability_domain of this InstancePoolPlacementConfiguration. The availability domain to place instances. + Example: `Uocm:PHX-AD-1` @@ -83,7 +85,9 @@ def availability_domain(self, availability_domain): def primary_subnet_id(self): """ **[Required]** Gets the primary_subnet_id of this InstancePoolPlacementConfiguration. - The OCID of the primary subnet to place instances. + The `OCID`__ of the primary subnet to place instances. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The primary_subnet_id of this InstancePoolPlacementConfiguration. @@ -95,7 +99,9 @@ def primary_subnet_id(self): def primary_subnet_id(self, primary_subnet_id): """ Sets the primary_subnet_id of this InstancePoolPlacementConfiguration. - The OCID of the primary subnet to place instances. + The `OCID`__ of the primary subnet to place instances. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param primary_subnet_id: The primary_subnet_id of this InstancePoolPlacementConfiguration. @@ -109,6 +115,19 @@ def fault_domains(self): Gets the fault_domains of this InstancePoolPlacementConfiguration. The fault domains to place instances. + If you don't provide any values, the system makes a best effort to distribute + instances across all fault domains based on capacity. + + To distribute the instances evenly across selected fault domains, provide a + set of fault domains. For example, you might want instances to be evenly + distributed if your applications require high availability. + + To get a list of fault domains, use the + :func:`list_fault_domains` operation + in the Identity and Access Management Service API. + + Example: `[FAULT-DOMAIN-1, FAULT-DOMAIN-2, FAULT-DOMAIN-3]` + :return: The fault_domains of this InstancePoolPlacementConfiguration. :rtype: list[str] @@ -121,6 +140,19 @@ def fault_domains(self, fault_domains): Sets the fault_domains of this InstancePoolPlacementConfiguration. The fault domains to place instances. + If you don't provide any values, the system makes a best effort to distribute + instances across all fault domains based on capacity. + + To distribute the instances evenly across selected fault domains, provide a + set of fault domains. For example, you might want instances to be evenly + distributed if your applications require high availability. + + To get a list of fault domains, use the + :func:`list_fault_domains` operation + in the Identity and Access Management Service API. + + Example: `[FAULT-DOMAIN-1, FAULT-DOMAIN-2, FAULT-DOMAIN-3]` + :param fault_domains: The fault_domains of this InstancePoolPlacementConfiguration. :type: list[str] diff --git a/src/oci/core/models/instance_pool_placement_secondary_vnic_subnet.py b/src/oci/core/models/instance_pool_placement_secondary_vnic_subnet.py index 3b588a045e..747a999111 100644 --- a/src/oci/core/models/instance_pool_placement_secondary_vnic_subnet.py +++ b/src/oci/core/models/instance_pool_placement_secondary_vnic_subnet.py @@ -43,8 +43,8 @@ def __init__(self, **kwargs): def display_name(self): """ Gets the display_name of this InstancePoolPlacementSecondaryVnicSubnet. - The displayName of the vnic. This is also use to match against the Instance Configuration defined - secondary vnic. + The display name of the VNIC. This is also use to match against the instance configuration defined + secondary VNIC. :return: The display_name of this InstancePoolPlacementSecondaryVnicSubnet. @@ -56,8 +56,8 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this InstancePoolPlacementSecondaryVnicSubnet. - The displayName of the vnic. This is also use to match against the Instance Configuration defined - secondary vnic. + The display name of the VNIC. This is also use to match against the instance configuration defined + secondary VNIC. :param display_name: The display_name of this InstancePoolPlacementSecondaryVnicSubnet. @@ -69,7 +69,9 @@ def display_name(self, display_name): def subnet_id(self): """ **[Required]** Gets the subnet_id of this InstancePoolPlacementSecondaryVnicSubnet. - The subnet OCID for the secondary vnic + The subnet `OCID`__ for the secondary VNIC. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The subnet_id of this InstancePoolPlacementSecondaryVnicSubnet. @@ -81,7 +83,9 @@ def subnet_id(self): def subnet_id(self, subnet_id): """ Sets the subnet_id of this InstancePoolPlacementSecondaryVnicSubnet. - The subnet OCID for the secondary vnic + The subnet `OCID`__ for the secondary VNIC. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param subnet_id: The subnet_id of this InstancePoolPlacementSecondaryVnicSubnet. 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 30ff6d7af9..ddd77b92be 100644 --- a/src/oci/core/models/instance_source_via_image_details.py +++ b/src/oci/core/models/instance_source_via_image_details.py @@ -107,7 +107,7 @@ def image_id(self, image_id): def kms_key_id(self): """ Gets the kms_key_id of this InstanceSourceViaImageDetails. - The OCID of the KMS key to be used as the master encryption key for the boot volume. + The OCID of the Key Management key to assign as the master encryption key for the boot volume. :return: The kms_key_id of this InstanceSourceViaImageDetails. @@ -119,7 +119,7 @@ def kms_key_id(self): def kms_key_id(self, kms_key_id): """ Sets the kms_key_id of this InstanceSourceViaImageDetails. - The OCID of the KMS key to be used as the master encryption key for the boot volume. + The OCID of the Key Management key to assign as the master encryption key for the boot volume. :param kms_key_id: The kms_key_id of this InstanceSourceViaImageDetails. diff --git a/src/oci/core/models/launch_instance_agent_config_details.py b/src/oci/core/models/launch_instance_agent_config_details.py index b3494f2742..087767d7d3 100644 --- a/src/oci/core/models/launch_instance_agent_config_details.py +++ b/src/oci/core/models/launch_instance_agent_config_details.py @@ -21,16 +21,23 @@ def __init__(self, **kwargs): The value to assign to the is_monitoring_disabled property of this LaunchInstanceAgentConfigDetails. :type is_monitoring_disabled: bool + :param is_management_disabled: + The value to assign to the is_management_disabled property of this LaunchInstanceAgentConfigDetails. + :type is_management_disabled: bool + """ self.swagger_types = { - 'is_monitoring_disabled': 'bool' + 'is_monitoring_disabled': 'bool', + 'is_management_disabled': 'bool' } self.attribute_map = { - 'is_monitoring_disabled': 'isMonitoringDisabled' + 'is_monitoring_disabled': 'isMonitoringDisabled', + 'is_management_disabled': 'isManagementDisabled' } self._is_monitoring_disabled = None + self._is_management_disabled = None @property def is_monitoring_disabled(self): @@ -58,6 +65,32 @@ def is_monitoring_disabled(self, is_monitoring_disabled): """ self._is_monitoring_disabled = is_monitoring_disabled + @property + def is_management_disabled(self): + """ + Gets the is_management_disabled of this LaunchInstanceAgentConfigDetails. + Whether the agent running on the instance can run all the available management plugins. + Default value is false. + + + :return: The is_management_disabled of this LaunchInstanceAgentConfigDetails. + :rtype: bool + """ + return self._is_management_disabled + + @is_management_disabled.setter + def is_management_disabled(self, is_management_disabled): + """ + Sets the is_management_disabled of this LaunchInstanceAgentConfigDetails. + Whether the agent running on the instance can run all the available management plugins. + Default value is false. + + + :param is_management_disabled: The is_management_disabled of this LaunchInstanceAgentConfigDetails. + :type: bool + """ + self._is_management_disabled = is_management_disabled + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/core/models/update_boot_volume_details.py b/src/oci/core/models/update_boot_volume_details.py index dcbd1e32d9..7d0d798667 100644 --- a/src/oci/core/models/update_boot_volume_details.py +++ b/src/oci/core/models/update_boot_volume_details.py @@ -182,7 +182,17 @@ def size_in_gbs(self, size_in_gbs): def vpus_per_gb(self): """ Gets the vpus_per_gb of this UpdateBootVolumeDetails. - The number of Volume Performance Units that will be applied to this boot volume per GB. + The number of volume performance units (VPUs) that will be applied to this volume per GB, + representing the Block Volume service's elastic performance options. + See `Block Volume Elastic Performance`__ for more information. + + Allowed values: + + * `10`: Represents Balanced option. + + * `20`: Represents Higher Performance option. + + __ https://docs.cloud.oracle.com/Content/Block/Concepts/blockvolumeelasticperformance.htm :return: The vpus_per_gb of this UpdateBootVolumeDetails. @@ -194,7 +204,17 @@ def vpus_per_gb(self): def vpus_per_gb(self, vpus_per_gb): """ Sets the vpus_per_gb of this UpdateBootVolumeDetails. - The number of Volume Performance Units that will be applied to this boot volume per GB. + The number of volume performance units (VPUs) that will be applied to this volume per GB, + representing the Block Volume service's elastic performance options. + See `Block Volume Elastic Performance`__ for more information. + + Allowed values: + + * `10`: Represents Balanced option. + + * `20`: Represents Higher Performance option. + + __ https://docs.cloud.oracle.com/Content/Block/Concepts/blockvolumeelasticperformance.htm :param vpus_per_gb: The vpus_per_gb of this UpdateBootVolumeDetails. diff --git a/src/oci/core/models/update_boot_volume_kms_key_details.py b/src/oci/core/models/update_boot_volume_kms_key_details.py index a66506c219..112e25014c 100644 --- a/src/oci/core/models/update_boot_volume_kms_key_details.py +++ b/src/oci/core/models/update_boot_volume_kms_key_details.py @@ -36,9 +36,9 @@ def __init__(self, **kwargs): def kms_key_id(self): """ Gets the kms_key_id of this UpdateBootVolumeKmsKeyDetails. - The OCID of the new KMS key which will be used to protect the specified volume. - This key has to be a valid KMS key OCID, and the user must have key delegation policy to allow them to access this key. - Even if the new KMS key is the same as the previous KMS key ID, the Block Volume service will use it to regenerate a new volume encryption key. + The OCID of the new Key Management key to assign to protect the specified volume. + This key has to be a valid Key Management key, and policies must exist to allow the user and the Block Volume service to access this key. + If you specify the same OCID as the previous key's OCID, the Block Volume service will use it to regenerate a volume encryption key. :return: The kms_key_id of this UpdateBootVolumeKmsKeyDetails. @@ -50,9 +50,9 @@ def kms_key_id(self): def kms_key_id(self, kms_key_id): """ Sets the kms_key_id of this UpdateBootVolumeKmsKeyDetails. - The OCID of the new KMS key which will be used to protect the specified volume. - This key has to be a valid KMS key OCID, and the user must have key delegation policy to allow them to access this key. - Even if the new KMS key is the same as the previous KMS key ID, the Block Volume service will use it to regenerate a new volume encryption key. + The OCID of the new Key Management key to assign to protect the specified volume. + This key has to be a valid Key Management key, and policies must exist to allow the user and the Block Volume service to access this key. + If you specify the same OCID as the previous key's OCID, the Block Volume service will use it to regenerate a volume encryption key. :param kms_key_id: The kms_key_id of this UpdateBootVolumeKmsKeyDetails. diff --git a/src/oci/core/models/update_instance_agent_config_details.py b/src/oci/core/models/update_instance_agent_config_details.py index e1b45523d1..2b8bd09748 100644 --- a/src/oci/core/models/update_instance_agent_config_details.py +++ b/src/oci/core/models/update_instance_agent_config_details.py @@ -21,16 +21,23 @@ def __init__(self, **kwargs): The value to assign to the is_monitoring_disabled property of this UpdateInstanceAgentConfigDetails. :type is_monitoring_disabled: bool + :param is_management_disabled: + The value to assign to the is_management_disabled property of this UpdateInstanceAgentConfigDetails. + :type is_management_disabled: bool + """ self.swagger_types = { - 'is_monitoring_disabled': 'bool' + 'is_monitoring_disabled': 'bool', + 'is_management_disabled': 'bool' } self.attribute_map = { - 'is_monitoring_disabled': 'isMonitoringDisabled' + 'is_monitoring_disabled': 'isMonitoringDisabled', + 'is_management_disabled': 'isManagementDisabled' } self._is_monitoring_disabled = None + self._is_management_disabled = None @property def is_monitoring_disabled(self): @@ -56,6 +63,30 @@ def is_monitoring_disabled(self, is_monitoring_disabled): """ self._is_monitoring_disabled = is_monitoring_disabled + @property + def is_management_disabled(self): + """ + Gets the is_management_disabled of this UpdateInstanceAgentConfigDetails. + Whether the agent running on the instance can run all the available management plugins + + + :return: The is_management_disabled of this UpdateInstanceAgentConfigDetails. + :rtype: bool + """ + return self._is_management_disabled + + @is_management_disabled.setter + def is_management_disabled(self, is_management_disabled): + """ + Sets the is_management_disabled of this UpdateInstanceAgentConfigDetails. + Whether the agent running on the instance can run all the available management plugins + + + :param is_management_disabled: The is_management_disabled of this UpdateInstanceAgentConfigDetails. + :type: bool + """ + self._is_management_disabled = is_management_disabled + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/core/models/update_instance_details.py b/src/oci/core/models/update_instance_details.py index e5ae3e6bf1..a2d417bb64 100644 --- a/src/oci/core/models/update_instance_details.py +++ b/src/oci/core/models/update_instance_details.py @@ -41,6 +41,10 @@ def __init__(self, **kwargs): The value to assign to the extended_metadata property of this UpdateInstanceDetails. :type extended_metadata: dict(str, object) + :param shape: + The value to assign to the shape property of this UpdateInstanceDetails. + :type shape: str + """ self.swagger_types = { 'defined_tags': 'dict(str, dict(str, object))', @@ -48,7 +52,8 @@ def __init__(self, **kwargs): 'freeform_tags': 'dict(str, str)', 'agent_config': 'UpdateInstanceAgentConfigDetails', 'metadata': 'dict(str, str)', - 'extended_metadata': 'dict(str, object)' + 'extended_metadata': 'dict(str, object)', + 'shape': 'str' } self.attribute_map = { @@ -57,7 +62,8 @@ def __init__(self, **kwargs): 'freeform_tags': 'freeformTags', 'agent_config': 'agentConfig', 'metadata': 'metadata', - 'extended_metadata': 'extendedMetadata' + 'extended_metadata': 'extendedMetadata', + 'shape': 'shape' } self._defined_tags = None @@ -66,6 +72,7 @@ def __init__(self, **kwargs): self._agent_config = None self._metadata = None self._extended_metadata = None + self._shape = None @property def defined_tags(self): @@ -269,6 +276,38 @@ def extended_metadata(self, extended_metadata): """ self._extended_metadata = extended_metadata + @property + def shape(self): + """ + Gets the shape of this UpdateInstanceDetails. + The shape of the instance. The shape determines the number of CPUs and the amount of memory + allocated to the instance. You can enumerate all available shapes by calling + :func:`list_shapes`. + + Example: `VM.Standard1.1` + + + :return: The shape of this UpdateInstanceDetails. + :rtype: str + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this UpdateInstanceDetails. + The shape of the instance. The shape determines the number of CPUs and the amount of memory + allocated to the instance. You can enumerate all available shapes by calling + :func:`list_shapes`. + + Example: `VM.Standard1.1` + + + :param shape: The shape of this UpdateInstanceDetails. + :type: str + """ + self._shape = shape + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/core/models/update_instance_pool_details.py b/src/oci/core/models/update_instance_pool_details.py index f0301479f5..d740b10603 100644 --- a/src/oci/core/models/update_instance_pool_details.py +++ b/src/oci/core/models/update_instance_pool_details.py @@ -165,7 +165,10 @@ def freeform_tags(self, freeform_tags): def instance_configuration_id(self): """ Gets the instance_configuration_id of this UpdateInstancePoolDetails. - The OCID of the instance configuration associated with the instance pool. + The `OCID`__ of the instance configuration associated with the + instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The instance_configuration_id of this UpdateInstancePoolDetails. @@ -177,7 +180,10 @@ def instance_configuration_id(self): def instance_configuration_id(self, instance_configuration_id): """ Sets the instance_configuration_id of this UpdateInstancePoolDetails. - The OCID of the instance configuration associated with the instance pool. + The `OCID`__ of the instance configuration associated with the + instance pool. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param instance_configuration_id: The instance_configuration_id of this UpdateInstancePoolDetails. diff --git a/src/oci/core/models/update_instance_pool_placement_configuration_details.py b/src/oci/core/models/update_instance_pool_placement_configuration_details.py index a3c14c3b64..8dd15efbe4 100644 --- a/src/oci/core/models/update_instance_pool_placement_configuration_details.py +++ b/src/oci/core/models/update_instance_pool_placement_configuration_details.py @@ -58,6 +58,7 @@ def availability_domain(self): """ **[Required]** Gets the availability_domain of this UpdateInstancePoolPlacementConfigurationDetails. The availability domain to place instances. + Example: `Uocm:PHX-AD-1` @@ -71,6 +72,7 @@ def availability_domain(self, availability_domain): """ Sets the availability_domain of this UpdateInstancePoolPlacementConfigurationDetails. The availability domain to place instances. + Example: `Uocm:PHX-AD-1` @@ -85,6 +87,19 @@ def fault_domains(self): Gets the fault_domains of this UpdateInstancePoolPlacementConfigurationDetails. The fault domains to place instances. + If you don't provide any values, the system makes a best effort to distribute + instances across all fault domains based on capacity. + + To distribute the instances evenly across selected fault domains, provide a + set of fault domains. For example, you might want instances to be evenly + distributed if your applications require high availability. + + To get a list of fault domains, use the + :func:`list_fault_domains` operation + in the Identity and Access Management Service API. + + Example: `[FAULT-DOMAIN-1, FAULT-DOMAIN-2, FAULT-DOMAIN-3]` + :return: The fault_domains of this UpdateInstancePoolPlacementConfigurationDetails. :rtype: list[str] @@ -97,6 +112,19 @@ def fault_domains(self, fault_domains): Sets the fault_domains of this UpdateInstancePoolPlacementConfigurationDetails. The fault domains to place instances. + If you don't provide any values, the system makes a best effort to distribute + instances across all fault domains based on capacity. + + To distribute the instances evenly across selected fault domains, provide a + set of fault domains. For example, you might want instances to be evenly + distributed if your applications require high availability. + + To get a list of fault domains, use the + :func:`list_fault_domains` operation + in the Identity and Access Management Service API. + + Example: `[FAULT-DOMAIN-1, FAULT-DOMAIN-2, FAULT-DOMAIN-3]` + :param fault_domains: The fault_domains of this UpdateInstancePoolPlacementConfigurationDetails. :type: list[str] diff --git a/src/oci/core/models/update_volume_backup_policy_details.py b/src/oci/core/models/update_volume_backup_policy_details.py index dbbf644b17..83128d1a49 100644 --- a/src/oci/core/models/update_volume_backup_policy_details.py +++ b/src/oci/core/models/update_volume_backup_policy_details.py @@ -9,7 +9,13 @@ @init_model_state_from_kwargs class UpdateVolumeBackupPolicyDetails(object): """ - Contains properties for updating a scheduled backup policy. + Specifies the properties for a updating a user defined backup policy. + For more information about user defined backup policies, + see `User Defined Policies`__ in + `Policy-Based Backups`__. + + __ https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#UserDefinedBackupPolicies + __ https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm """ def __init__(self, **kwargs): @@ -83,7 +89,12 @@ def display_name(self, display_name): def schedules(self): """ Gets the schedules of this UpdateVolumeBackupPolicyDetails. - The collection of schedules that this policy will apply. + The collection of schedules for the volume backup policy. See + see `Schedules`__ in + `Policy-Based Backups`__ for more information. + + __ https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#schedules + __ https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm :return: The schedules of this UpdateVolumeBackupPolicyDetails. @@ -95,7 +106,12 @@ def schedules(self): def schedules(self, schedules): """ Sets the schedules of this UpdateVolumeBackupPolicyDetails. - The collection of schedules that this policy will apply. + The collection of schedules for the volume backup policy. See + see `Schedules`__ in + `Policy-Based Backups`__ for more information. + + __ https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#schedules + __ https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm :param schedules: The schedules of this UpdateVolumeBackupPolicyDetails. diff --git a/src/oci/core/models/update_volume_details.py b/src/oci/core/models/update_volume_details.py index 3d6e757976..134660978f 100644 --- a/src/oci/core/models/update_volume_details.py +++ b/src/oci/core/models/update_volume_details.py @@ -158,7 +158,19 @@ def freeform_tags(self, freeform_tags): def vpus_per_gb(self): """ Gets the vpus_per_gb of this UpdateVolumeDetails. - The number of Volume Performance Units that will be applied to this volume per GB. + The number of volume performance units (VPUs) that will be applied to this volume per GB, + representing the Block Volume service's elastic performance options. + See `Block Volume Elastic Performance`__ for more information. + + Allowed values: + + * `0`: Represents Lower Cost option. + + * `10`: Represents Balanced option. + + * `20`: Represents Higher Performance option. + + __ https://docs.cloud.oracle.com/Content/Block/Concepts/blockvolumeelasticperformance.htm :return: The vpus_per_gb of this UpdateVolumeDetails. @@ -170,7 +182,19 @@ def vpus_per_gb(self): def vpus_per_gb(self, vpus_per_gb): """ Sets the vpus_per_gb of this UpdateVolumeDetails. - The number of Volume Performance Units that will be applied to this volume per GB. + The number of volume performance units (VPUs) that will be applied to this volume per GB, + representing the Block Volume service's elastic performance options. + See `Block Volume Elastic Performance`__ for more information. + + Allowed values: + + * `0`: Represents Lower Cost option. + + * `10`: Represents Balanced option. + + * `20`: Represents Higher Performance option. + + __ https://docs.cloud.oracle.com/Content/Block/Concepts/blockvolumeelasticperformance.htm :param vpus_per_gb: The vpus_per_gb of this UpdateVolumeDetails. diff --git a/src/oci/core/models/update_volume_kms_key_details.py b/src/oci/core/models/update_volume_kms_key_details.py index 6314a6cf7b..a2b71d7715 100644 --- a/src/oci/core/models/update_volume_kms_key_details.py +++ b/src/oci/core/models/update_volume_kms_key_details.py @@ -36,9 +36,9 @@ def __init__(self, **kwargs): def kms_key_id(self): """ Gets the kms_key_id of this UpdateVolumeKmsKeyDetails. - The OCID of the new KMS key which will be used to protect the specified volume. - This key has to be a valid KMS key OCID, and the user must have key delegation policy to allow them to access this key. - Even if the new KMS key is the same as the previous KMS key ID, the Block Volume service will use it to regenerate a new volume encryption key. + The OCID of the new Key Management key to assign to protect the specified volume. + This key has to be a valid Key Management key, and policies must exist to allow the user and the Block Volume service to access this key. + If you specify the same OCID as the previous key's OCID, the Block Volume service will use it to regenerate a volume encryption key. :return: The kms_key_id of this UpdateVolumeKmsKeyDetails. @@ -50,9 +50,9 @@ def kms_key_id(self): def kms_key_id(self, kms_key_id): """ Sets the kms_key_id of this UpdateVolumeKmsKeyDetails. - The OCID of the new KMS key which will be used to protect the specified volume. - This key has to be a valid KMS key OCID, and the user must have key delegation policy to allow them to access this key. - Even if the new KMS key is the same as the previous KMS key ID, the Block Volume service will use it to regenerate a new volume encryption key. + The OCID of the new Key Management key to assign to protect the specified volume. + This key has to be a valid Key Management key, and policies must exist to allow the user and the Block Volume service to access this key. + If you specify the same OCID as the previous key's OCID, the Block Volume service will use it to regenerate a volume encryption key. :param kms_key_id: The kms_key_id of this UpdateVolumeKmsKeyDetails. diff --git a/src/oci/core/models/volume.py b/src/oci/core/models/volume.py index 3595532ad4..be3eef90b3 100644 --- a/src/oci/core/models/volume.py +++ b/src/oci/core/models/volume.py @@ -399,7 +399,7 @@ def is_hydrated(self, is_hydrated): def kms_key_id(self): """ Gets the kms_key_id of this Volume. - The OCID of the KMS key which is the master encryption key for the volume. + The OCID of the Key Management key which is the master encryption key for the volume. :return: The kms_key_id of this Volume. @@ -411,7 +411,7 @@ def kms_key_id(self): def kms_key_id(self, kms_key_id): """ Sets the kms_key_id of this Volume. - The OCID of the KMS key which is the master encryption key for the volume. + The OCID of the Key Management key which is the master encryption key for the volume. :param kms_key_id: The kms_key_id of this Volume. @@ -453,7 +453,19 @@ def lifecycle_state(self, lifecycle_state): def vpus_per_gb(self): """ Gets the vpus_per_gb of this Volume. - The number of Volume Performance Units that will be applied to this volume per GB. + The number of volume performance units (VPUs) that will be applied to this volume per GB, + representing the Block Volume service's elastic performance options. + See `Block Volume Elastic Performance`__ for more information. + + Allowed values: + + * `0`: Represents Lower Cost option. + + * `10`: Represents Balanced option. + + * `20`: Represents Higher Performance option. + + __ https://docs.cloud.oracle.com/Content/Block/Concepts/blockvolumeelasticperformance.htm :return: The vpus_per_gb of this Volume. @@ -465,7 +477,19 @@ def vpus_per_gb(self): def vpus_per_gb(self, vpus_per_gb): """ Sets the vpus_per_gb of this Volume. - The number of Volume Performance Units that will be applied to this volume per GB. + The number of volume performance units (VPUs) that will be applied to this volume per GB, + representing the Block Volume service's elastic performance options. + See `Block Volume Elastic Performance`__ for more information. + + Allowed values: + + * `0`: Represents Lower Cost option. + + * `10`: Represents Balanced option. + + * `20`: Represents Higher Performance option. + + __ https://docs.cloud.oracle.com/Content/Block/Concepts/blockvolumeelasticperformance.htm :param vpus_per_gb: The vpus_per_gb of this Volume. diff --git a/src/oci/core/models/volume_backup.py b/src/oci/core/models/volume_backup.py index 617376ffd7..fddcd201cc 100644 --- a/src/oci/core/models/volume_backup.py +++ b/src/oci/core/models/volume_backup.py @@ -420,7 +420,7 @@ def id(self, id): def kms_key_id(self): """ Gets the kms_key_id of this VolumeBackup. - The OCID of the KMS key which is the master encryption key for the volume backup. + The OCID of the Key Management key which is the master encryption key for the volume backup. For more information about the Key Management service and encryption keys, see `Overview of Key Management`__ and `Using Keys`__. @@ -438,7 +438,7 @@ def kms_key_id(self): def kms_key_id(self, kms_key_id): """ Sets the kms_key_id of this VolumeBackup. - The OCID of the KMS key which is the master encryption key for the volume backup. + The OCID of the Key Management key which is the master encryption key for the volume backup. For more information about the Key Management service and encryption keys, see `Overview of Key Management`__ and `Using Keys`__. diff --git a/src/oci/core/models/volume_backup_policy_assignment.py b/src/oci/core/models/volume_backup_policy_assignment.py index 2e067299b8..ede78a924a 100644 --- a/src/oci/core/models/volume_backup_policy_assignment.py +++ b/src/oci/core/models/volume_backup_policy_assignment.py @@ -9,7 +9,12 @@ @init_model_state_from_kwargs class VolumeBackupPolicyAssignment(object): """ - Specifies that a particular volume backup policy is assigned to an asset such as a volume. + Specifies the volume that the volume backup policy is assigned to. + + For more information about Oracle defined backup policies and custom backup policies, + see `Policy-Based Backups`__. + + __ https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm """ def __init__(self, **kwargs): @@ -57,7 +62,7 @@ def __init__(self, **kwargs): def asset_id(self): """ **[Required]** Gets the asset_id of this VolumeBackupPolicyAssignment. - The OCID of the asset (e.g. a volume) to which the policy has been assigned. + The OCID of the volume the policy has been assigned to. :return: The asset_id of this VolumeBackupPolicyAssignment. @@ -69,7 +74,7 @@ def asset_id(self): def asset_id(self, asset_id): """ Sets the asset_id of this VolumeBackupPolicyAssignment. - The OCID of the asset (e.g. a volume) to which the policy has been assigned. + The OCID of the volume the policy has been assigned to. :param asset_id: The asset_id of this VolumeBackupPolicyAssignment. @@ -105,7 +110,7 @@ def id(self, id): def policy_id(self): """ **[Required]** Gets the policy_id of this VolumeBackupPolicyAssignment. - The OCID of the volume backup policy that has been assigned to an asset. + The OCID of the volume backup policy that has been assigned to the volume. :return: The policy_id of this VolumeBackupPolicyAssignment. @@ -117,7 +122,7 @@ def policy_id(self): def policy_id(self, policy_id): """ Sets the policy_id of this VolumeBackupPolicyAssignment. - The OCID of the volume backup policy that has been assigned to an asset. + The OCID of the volume backup policy that has been assigned to the volume. :param policy_id: The policy_id of this VolumeBackupPolicyAssignment. @@ -129,7 +134,7 @@ def policy_id(self, policy_id): def time_created(self): """ **[Required]** Gets the time_created of this VolumeBackupPolicyAssignment. - The date and time the volume backup policy assignment was created. Format defined by RFC3339. + The date and time the volume backup policy was assigned to the volume. The format is defined by RFC3339. :return: The time_created of this VolumeBackupPolicyAssignment. @@ -141,7 +146,7 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this VolumeBackupPolicyAssignment. - The date and time the volume backup policy assignment was created. Format defined by RFC3339. + The date and time the volume backup policy was assigned to the volume. The format is defined by RFC3339. :param time_created: The time_created of this VolumeBackupPolicyAssignment. diff --git a/src/oci/core/models/volume_backup_schedule.py b/src/oci/core/models/volume_backup_schedule.py index 4dcb8ac5dc..d69cb345f7 100644 --- a/src/oci/core/models/volume_backup_schedule.py +++ b/src/oci/core/models/volume_backup_schedule.py @@ -9,7 +9,10 @@ @init_model_state_from_kwargs class VolumeBackupSchedule(object): """ - Defines a chronological recurrence pattern for creating scheduled backups at a particular periodicity. + Defines the backup frequency and retention period for a volume backup policy. For more information, + see `Policy-Based Backups`__. + + __ https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm """ #: A constant which can be used with the backup_type property of a VolumeBackupSchedule. @@ -231,7 +234,7 @@ def __init__(self, **kwargs): def backup_type(self): """ **[Required]** Gets the backup_type of this VolumeBackupSchedule. - The type of backup to create. + The type of volume backup to create. Allowed values for this property are: "FULL", "INCREMENTAL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -246,7 +249,7 @@ def backup_type(self): def backup_type(self, backup_type): """ Sets the backup_type of this VolumeBackupSchedule. - The type of backup to create. + The type of volume backup to create. :param backup_type: The backup_type of this VolumeBackupSchedule. @@ -261,7 +264,7 @@ def backup_type(self, backup_type): def offset_seconds(self): """ Gets the offset_seconds of this VolumeBackupSchedule. - The number of seconds that the backup time should be shifted from the default interval boundaries specified by the period. Backup time = Frequency start time + Offset. + The number of seconds that the volume backup start time should be shifted from the default interval boundaries specified by the period. The volume backup start time is the frequency start time plus the offset. :return: The offset_seconds of this VolumeBackupSchedule. @@ -273,7 +276,7 @@ def offset_seconds(self): def offset_seconds(self, offset_seconds): """ Sets the offset_seconds of this VolumeBackupSchedule. - The number of seconds that the backup time should be shifted from the default interval boundaries specified by the period. Backup time = Frequency start time + Offset. + The number of seconds that the volume backup start time should be shifted from the default interval boundaries specified by the period. The volume backup start time is the frequency start time plus the offset. :param offset_seconds: The offset_seconds of this VolumeBackupSchedule. @@ -285,7 +288,7 @@ def offset_seconds(self, offset_seconds): def period(self): """ **[Required]** Gets the period of this VolumeBackupSchedule. - How often the backup should occur. + The volume backup frequency. Allowed values for this property are: "ONE_HOUR", "ONE_DAY", "ONE_WEEK", "ONE_MONTH", "ONE_YEAR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -300,7 +303,7 @@ def period(self): def period(self, period): """ Sets the period of this VolumeBackupSchedule. - How often the backup should occur. + The volume backup frequency. :param period: The period of this VolumeBackupSchedule. @@ -315,7 +318,21 @@ def period(self, period): def offset_type(self): """ Gets the offset_type of this VolumeBackupSchedule. - Indicates how offset is defined. If value is `STRUCTURED`, then `hourOfDay`, `dayOfWeek`, `dayOfMonth`, and `month` fields are used and `offsetSeconds` will be ignored in requests and users should ignore its value from the respones. `hourOfDay` is applicable for periods `ONE_DAY`, `ONE_WEEK`, `ONE_MONTH` and `ONE_YEAR`. `dayOfWeek` is applicable for period `ONE_WEEK`. `dayOfMonth` is applicable for periods `ONE_MONTH` and `ONE_YEAR`. 'month' is applicable for period 'ONE_YEAR'. They will be ignored in the requests for inapplicable periods. If value is `NUMERIC_SECONDS`, then `offsetSeconds` will be used for both requests and responses and the structured fields will be ignored in the requests and users should ignore their values from the respones. For clients using older versions of Apis and not sending `offsetType` in their requests, the behaviour is just like `NUMERIC_SECONDS`. + Indicates how the offset is defined. If value is `STRUCTURED`, then `hourOfDay`, `dayOfWeek`, `dayOfMonth`, and `month` fields are used and `offsetSeconds` will be ignored in requests and users should ignore its value from the responses. + + `hourOfDay` is applicable for periods `ONE_DAY`, `ONE_WEEK`, `ONE_MONTH` and `ONE_YEAR`. + + `dayOfWeek` is applicable for period `ONE_WEEK`. + + `dayOfMonth` is applicable for periods `ONE_MONTH` and `ONE_YEAR`. + + 'month' is applicable for period 'ONE_YEAR'. + + They will be ignored in the requests for inapplicable periods. + + If value is `NUMERIC_SECONDS`, then `offsetSeconds` will be used for both requests and responses and the structured fields will be ignored in the requests and users should ignore their values from the responses. + + For clients using older versions of Apis and not sending `offsetType` in their requests, the behaviour is just like `NUMERIC_SECONDS`. Allowed values for this property are: "STRUCTURED", "NUMERIC_SECONDS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -330,7 +347,21 @@ def offset_type(self): def offset_type(self, offset_type): """ Sets the offset_type of this VolumeBackupSchedule. - Indicates how offset is defined. If value is `STRUCTURED`, then `hourOfDay`, `dayOfWeek`, `dayOfMonth`, and `month` fields are used and `offsetSeconds` will be ignored in requests and users should ignore its value from the respones. `hourOfDay` is applicable for periods `ONE_DAY`, `ONE_WEEK`, `ONE_MONTH` and `ONE_YEAR`. `dayOfWeek` is applicable for period `ONE_WEEK`. `dayOfMonth` is applicable for periods `ONE_MONTH` and `ONE_YEAR`. 'month' is applicable for period 'ONE_YEAR'. They will be ignored in the requests for inapplicable periods. If value is `NUMERIC_SECONDS`, then `offsetSeconds` will be used for both requests and responses and the structured fields will be ignored in the requests and users should ignore their values from the respones. For clients using older versions of Apis and not sending `offsetType` in their requests, the behaviour is just like `NUMERIC_SECONDS`. + Indicates how the offset is defined. If value is `STRUCTURED`, then `hourOfDay`, `dayOfWeek`, `dayOfMonth`, and `month` fields are used and `offsetSeconds` will be ignored in requests and users should ignore its value from the responses. + + `hourOfDay` is applicable for periods `ONE_DAY`, `ONE_WEEK`, `ONE_MONTH` and `ONE_YEAR`. + + `dayOfWeek` is applicable for period `ONE_WEEK`. + + `dayOfMonth` is applicable for periods `ONE_MONTH` and `ONE_YEAR`. + + 'month' is applicable for period 'ONE_YEAR'. + + They will be ignored in the requests for inapplicable periods. + + If value is `NUMERIC_SECONDS`, then `offsetSeconds` will be used for both requests and responses and the structured fields will be ignored in the requests and users should ignore their values from the responses. + + For clients using older versions of Apis and not sending `offsetType` in their requests, the behaviour is just like `NUMERIC_SECONDS`. :param offset_type: The offset_type of this VolumeBackupSchedule. @@ -345,7 +376,7 @@ def offset_type(self, offset_type): def hour_of_day(self): """ Gets the hour_of_day of this VolumeBackupSchedule. - The hour of the day to schedule the backup + The hour of the day to schedule the volume backup. :return: The hour_of_day of this VolumeBackupSchedule. @@ -357,7 +388,7 @@ def hour_of_day(self): def hour_of_day(self, hour_of_day): """ Sets the hour_of_day of this VolumeBackupSchedule. - The hour of the day to schedule the backup + The hour of the day to schedule the volume backup. :param hour_of_day: The hour_of_day of this VolumeBackupSchedule. @@ -369,7 +400,7 @@ def hour_of_day(self, hour_of_day): def day_of_week(self): """ Gets the day_of_week of this VolumeBackupSchedule. - The day of the week to schedule the backup + The day of the week to schedule the volume backup. Allowed values for this property are: "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -384,7 +415,7 @@ def day_of_week(self): def day_of_week(self, day_of_week): """ Sets the day_of_week of this VolumeBackupSchedule. - The day of the week to schedule the backup + The day of the week to schedule the volume backup. :param day_of_week: The day_of_week of this VolumeBackupSchedule. @@ -399,7 +430,7 @@ def day_of_week(self, day_of_week): def day_of_month(self): """ Gets the day_of_month of this VolumeBackupSchedule. - The day of the month to schedule the backup + The day of the month to schedule the volume backup. :return: The day_of_month of this VolumeBackupSchedule. @@ -411,7 +442,7 @@ def day_of_month(self): def day_of_month(self, day_of_month): """ Sets the day_of_month of this VolumeBackupSchedule. - The day of the month to schedule the backup + The day of the month to schedule the volume backup. :param day_of_month: The day_of_month of this VolumeBackupSchedule. @@ -423,7 +454,7 @@ def day_of_month(self, day_of_month): def month(self): """ Gets the month of this VolumeBackupSchedule. - The month of the year to schedule the backup + The month of the year to schedule the volume backup. Allowed values for this property are: "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -438,7 +469,7 @@ def month(self): def month(self, month): """ Sets the month of this VolumeBackupSchedule. - The month of the year to schedule the backup + The month of the year to schedule the volume backup. :param month: The month of this VolumeBackupSchedule. @@ -453,7 +484,7 @@ def month(self, month): def retention_seconds(self): """ **[Required]** Gets the retention_seconds of this VolumeBackupSchedule. - How long, in seconds, backups created by this schedule should be kept until being automatically deleted. + How long, in seconds, to keep the volume backups created by this schedule. :return: The retention_seconds of this VolumeBackupSchedule. @@ -465,7 +496,7 @@ def retention_seconds(self): def retention_seconds(self, retention_seconds): """ Sets the retention_seconds of this VolumeBackupSchedule. - How long, in seconds, backups created by this schedule should be kept until being automatically deleted. + How long, in seconds, to keep the volume backups created by this schedule. :param retention_seconds: The retention_seconds of this VolumeBackupSchedule. diff --git a/src/oci/core/models/volume_kms_key.py b/src/oci/core/models/volume_kms_key.py index 988cdd024f..688e2ac896 100644 --- a/src/oci/core/models/volume_kms_key.py +++ b/src/oci/core/models/volume_kms_key.py @@ -9,7 +9,7 @@ @init_model_state_from_kwargs class VolumeKmsKey(object): """ - The KMS key OCID associated with this volume. + The Key Management master encryption key associated with this volume. """ def __init__(self, **kwargs): @@ -36,7 +36,7 @@ def __init__(self, **kwargs): def kms_key_id(self): """ Gets the kms_key_id of this VolumeKmsKey. - The KMS key OCID associated with this volume. If the volume is not using KMS, then the `kmsKeyId` will be a null string. + The OCID of the Key Management key assigned to this volume. If the volume is not using Key Management, then the `kmsKeyId` will be a null string. :return: The kms_key_id of this VolumeKmsKey. @@ -48,7 +48,7 @@ def kms_key_id(self): def kms_key_id(self, kms_key_id): """ Sets the kms_key_id of this VolumeKmsKey. - The KMS key OCID associated with this volume. If the volume is not using KMS, then the `kmsKeyId` will be a null string. + The OCID of the Key Management key assigned to this volume. If the volume is not using Key Management, then the `kmsKeyId` will be a null string. :param kms_key_id: The kms_key_id of this VolumeKmsKey. diff --git a/src/oci/dns/dns_client.py b/src/oci/dns/dns_client.py index 7f25cdca20..9f031aef19 100644 --- a/src/oci/dns/dns_client.py +++ b/src/oci/dns/dns_client.py @@ -83,7 +83,7 @@ def __init__(self, config, **kwargs): def change_steering_policy_compartment(self, steering_policy_id, change_steering_policy_compartment_details, **kwargs): """ - Moves a steering policy into a different compartment. When provided, If-Match is checked against ETag values of the resource. + Moves a steering policy into a different compartment. :param str steering_policy_id: (required) @@ -107,6 +107,11 @@ def change_steering_policy_compartment(self, steering_policy_id, change_steering deleted and purged from the system, then a retry of the original creation request may be rejected). + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -125,7 +130,8 @@ def change_steering_policy_compartment(self, steering_policy_id, change_steering expected_kwargs = [ "retry_strategy", "if_match", - "opc_retry_token" + "opc_retry_token", + "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -146,7 +152,8 @@ def change_steering_policy_compartment(self, steering_policy_id, change_steering "accept": "application/json", "content-type": "application/json", "If-Match": kwargs.get("if_match", missing), - "opc-retry-token": kwargs.get("opc_retry_token", missing) + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -172,9 +179,107 @@ def change_steering_policy_compartment(self, steering_policy_id, change_steering header_params=header_params, body=change_steering_policy_compartment_details) + def change_tsig_key_compartment(self, tsig_key_id, change_tsig_key_compartment_details, **kwargs): + """ + Moves a TSIG key into a different compartment. + + + :param str tsig_key_id: (required) + The OCID of the target TSIG key. + + :param ChangeTsigKeyCompartmentDetails change_tsig_key_compartment_details: (required) + Details for moving a TSIG key into a different compartment. + + :param str if_match: (optional) + The `If-Match` header field makes the request method conditional on the + existence of at least one current representation of the target resource, + when the field-value is `*`, or having a current representation of the + target resource that has an entity-tag matching a member of the list of + entity-tags provided in the field-value. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case + of a timeout or server error without risk of executing that same action + again. Retry tokens expire after 24 hours, but can be invalidated before + then due to conflicting operations (for example, if a resource has been + deleted and purged from the system, then a retry of the original creation + request may be rejected). + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/tsigKeys/{tsigKeyId}/actions/changeCompartment" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "if_match", + "opc_retry_token", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "change_tsig_key_compartment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "tsigKeyId": tsig_key_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "If-Match": kwargs.get("if_match", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=change_tsig_key_compartment_details) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=change_tsig_key_compartment_details) + def change_zone_compartment(self, zone_id, change_zone_compartment_details, **kwargs): """ - Moves a zone into a different compartment. When provided, If-Match is checked against ETag values of the resource. + Moves a zone into a different compartment. **Note:** All SteeringPolicyAttachment objects associated with this zone will also be moved into the provided compartment. @@ -199,6 +304,11 @@ def change_zone_compartment(self, zone_id, change_zone_compartment_details, **kw deleted and purged from the system, then a retry of the original creation request may be rejected). + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -217,7 +327,8 @@ def change_zone_compartment(self, zone_id, change_zone_compartment_details, **kw expected_kwargs = [ "retry_strategy", "if_match", - "opc_retry_token" + "opc_retry_token", + "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -238,7 +349,8 @@ def change_zone_compartment(self, zone_id, change_zone_compartment_details, **kw "accept": "application/json", "content-type": "application/json", "If-Match": kwargs.get("if_match", missing), - "opc-retry-token": kwargs.get("opc_retry_token", missing) + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -283,6 +395,11 @@ def create_steering_policy(self, create_steering_policy_details, **kwargs): deleted and purged from the system, then a retry of the original creation request may be rejected). + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -300,7 +417,8 @@ def create_steering_policy(self, create_steering_policy_details, **kwargs): # Don't accept unknown kwargs expected_kwargs = [ "retry_strategy", - "opc_retry_token" + "opc_retry_token", + "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -310,7 +428,8 @@ def create_steering_policy(self, create_steering_policy_details, **kwargs): header_params = { "accept": "application/json", "content-type": "application/json", - "opc-retry-token": kwargs.get("opc_retry_token", missing) + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -357,6 +476,11 @@ def create_steering_policy_attachment(self, create_steering_policy_attachment_de deleted and purged from the system, then a retry of the original creation request may be rejected). + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -374,7 +498,8 @@ def create_steering_policy_attachment(self, create_steering_policy_attachment_de # Don't accept unknown kwargs expected_kwargs = [ "retry_strategy", - "opc_retry_token" + "opc_retry_token", + "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -384,7 +509,8 @@ def create_steering_policy_attachment(self, create_steering_policy_attachment_de header_params = { "accept": "application/json", "content-type": "application/json", - "opc-retry-token": kwargs.get("opc_retry_token", missing) + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -410,6 +536,71 @@ def create_steering_policy_attachment(self, create_steering_policy_attachment_de body=create_steering_policy_attachment_details, response_type="SteeringPolicyAttachment") + def create_tsig_key(self, create_tsig_key_details, **kwargs): + """ + Creates a new TSIG key in the specified compartment. There is no + `opc-retry-token` header since TSIG key names must be globally unique. + + + :param CreateTsigKeyDetails create_tsig_key_details: (required) + Details for creating a new TSIG key. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.dns.models.TsigKey` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/tsigKeys" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_tsig_key got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_tsig_key_details, + response_type="TsigKey") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_tsig_key_details, + response_type="TsigKey") + def create_zone(self, create_zone_details, **kwargs): """ Creates a new zone in the specified compartment. The `compartmentId` @@ -420,6 +611,11 @@ def create_zone(self, create_zone_details, **kwargs): :param CreateZoneBaseDetails create_zone_details: (required) Details for creating a new zone. + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. @@ -440,6 +636,7 @@ def create_zone(self, create_zone_details, **kwargs): # Don't accept unknown kwargs expected_kwargs = [ "retry_strategy", + "opc_request_id", "compartment_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] @@ -454,8 +651,10 @@ def create_zone(self, create_zone_details, **kwargs): header_params = { "accept": "application/json", - "content-type": "application/json" + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} retry_strategy = self.retry_strategy if kwargs.get('retry_strategy'): @@ -504,6 +703,11 @@ def delete_domain_records(self, zone_name_or_id, domain, **kwargs): field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation. + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. @@ -526,6 +730,7 @@ def delete_domain_records(self, zone_name_or_id, domain, **kwargs): "retry_strategy", "if_match", "if_unmodified_since", + "opc_request_id", "compartment_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] @@ -553,7 +758,8 @@ def delete_domain_records(self, zone_name_or_id, domain, **kwargs): "accept": "application/json", "content-type": "application/json", "If-Match": kwargs.get("if_match", missing), - "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing) + "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -605,6 +811,11 @@ def delete_rr_set(self, zone_name_or_id, domain, rtype, **kwargs): field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation. + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. @@ -627,6 +838,7 @@ def delete_rr_set(self, zone_name_or_id, domain, rtype, **kwargs): "retry_strategy", "if_match", "if_unmodified_since", + "opc_request_id", "compartment_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] @@ -655,7 +867,8 @@ def delete_rr_set(self, zone_name_or_id, domain, rtype, **kwargs): "accept": "application/json", "content-type": "application/json", "If-Match": kwargs.get("if_match", missing), - "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing) + "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -704,6 +917,11 @@ def delete_steering_policy(self, steering_policy_id, **kwargs): field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation. + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -722,7 +940,8 @@ def delete_steering_policy(self, steering_policy_id, **kwargs): expected_kwargs = [ "retry_strategy", "if_match", - "if_unmodified_since" + "if_unmodified_since", + "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -743,7 +962,8 @@ def delete_steering_policy(self, steering_policy_id, **kwargs): "accept": "application/json", "content-type": "application/json", "If-Match": kwargs.get("if_match", missing), - "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing) + "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -788,6 +1008,11 @@ def delete_steering_policy_attachment(self, steering_policy_attachment_id, **kwa field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation. + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -806,7 +1031,8 @@ def delete_steering_policy_attachment(self, steering_policy_attachment_id, **kwa expected_kwargs = [ "retry_strategy", "if_match", - "if_unmodified_since" + "if_unmodified_since", + "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -827,7 +1053,98 @@ def delete_steering_policy_attachment(self, steering_policy_attachment_id, **kwa "accept": "application/json", "content-type": "application/json", "If-Match": kwargs.get("if_match", missing), - "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing) + "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params) + + def delete_tsig_key(self, tsig_key_id, **kwargs): + """ + Deletes the specified TSIG key. + + + :param str tsig_key_id: (required) + The OCID of the target TSIG key. + + :param str if_match: (optional) + The `If-Match` header field makes the request method conditional on the + existence of at least one current representation of the target resource, + when the field-value is `*`, or having a current representation of the + target resource that has an entity-tag matching a member of the list of + entity-tags provided in the field-value. + + :param str if_unmodified_since: (optional) + The `If-Unmodified-Since` header field makes the request method + conditional on the selected representation's last modification date being + earlier than or equal to the date provided in the field-value. This + field accomplishes the same purpose as If-Match for cases where the user + agent does not have an entity-tag for the representation. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/tsigKeys/{tsigKeyId}" + method = "DELETE" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "if_match", + "if_unmodified_since", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "delete_tsig_key got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "tsigKeyId": tsig_key_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "If-Match": kwargs.get("if_match", missing), + "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -872,6 +1189,11 @@ def delete_zone(self, zone_name_or_id, **kwargs): field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation. + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. @@ -894,6 +1216,7 @@ def delete_zone(self, zone_name_or_id, **kwargs): "retry_strategy", "if_match", "if_unmodified_since", + "opc_request_id", "compartment_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] @@ -920,7 +1243,8 @@ def delete_zone(self, zone_name_or_id, **kwargs): "accept": "application/json", "content-type": "application/json", "If-Match": kwargs.get("if_match", missing), - "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing) + "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -969,6 +1293,11 @@ def get_domain_records(self, zone_name_or_id, domain, **kwargs): recent than the date provided in the field-value. Transfer of the selected representation's data is avoided if that data has not changed. + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param int limit: (optional) The maximum number of items to return in a page of the collection. @@ -1016,6 +1345,7 @@ def get_domain_records(self, zone_name_or_id, domain, **kwargs): "retry_strategy", "if_none_match", "if_modified_since", + "opc_request_id", "limit", "page", "zone_version", @@ -1069,7 +1399,8 @@ def get_domain_records(self, zone_name_or_id, domain, **kwargs): "accept": "application/json", "content-type": "application/json", "If-None-Match": kwargs.get("if_none_match", missing), - "If-Modified-Since": kwargs.get("if_modified_since", missing) + "If-Modified-Since": kwargs.get("if_modified_since", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -1122,6 +1453,11 @@ def get_rr_set(self, zone_name_or_id, domain, rtype, **kwargs): recent than the date provided in the field-value. Transfer of the selected representation's data is avoided if that data has not changed. + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param int limit: (optional) The maximum number of items to return in a page of the collection. @@ -1153,6 +1489,7 @@ def get_rr_set(self, zone_name_or_id, domain, rtype, **kwargs): "retry_strategy", "if_none_match", "if_modified_since", + "opc_request_id", "limit", "page", "zone_version", @@ -1187,7 +1524,8 @@ def get_rr_set(self, zone_name_or_id, domain, rtype, **kwargs): "accept": "application/json", "content-type": "application/json", "If-None-Match": kwargs.get("if_none_match", missing), - "If-Modified-Since": kwargs.get("if_modified_since", missing) + "If-Modified-Since": kwargs.get("if_modified_since", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -1233,6 +1571,11 @@ def get_steering_policy(self, steering_policy_id, **kwargs): recent than the date provided in the field-value. Transfer of the selected representation's data is avoided if that data has not changed. + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -1251,7 +1594,8 @@ def get_steering_policy(self, steering_policy_id, **kwargs): expected_kwargs = [ "retry_strategy", "if_none_match", - "if_modified_since" + "if_modified_since", + "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -1272,7 +1616,8 @@ def get_steering_policy(self, steering_policy_id, **kwargs): "accept": "application/json", "content-type": "application/json", "If-None-Match": kwargs.get("if_none_match", missing), - "If-Modified-Since": kwargs.get("if_modified_since", missing) + "If-Modified-Since": kwargs.get("if_modified_since", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -1316,6 +1661,11 @@ def get_steering_policy_attachment(self, steering_policy_attachment_id, **kwargs recent than the date provided in the field-value. Transfer of the selected representation's data is avoided if that data has not changed. + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -1334,7 +1684,8 @@ def get_steering_policy_attachment(self, steering_policy_attachment_id, **kwargs expected_kwargs = [ "retry_strategy", "if_none_match", - "if_modified_since" + "if_modified_since", + "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -1355,7 +1706,8 @@ def get_steering_policy_attachment(self, steering_policy_attachment_id, **kwargs "accept": "application/json", "content-type": "application/json", "If-None-Match": kwargs.get("if_none_match", missing), - "If-Modified-Since": kwargs.get("if_modified_since", missing) + "If-Modified-Since": kwargs.get("if_modified_since", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -1379,6 +1731,96 @@ def get_steering_policy_attachment(self, steering_policy_attachment_id, **kwargs header_params=header_params, response_type="SteeringPolicyAttachment") + def get_tsig_key(self, tsig_key_id, **kwargs): + """ + Gets information about the specified TSIG key. + + + :param str tsig_key_id: (required) + The OCID of the target TSIG key. + + :param str if_none_match: (optional) + The `If-None-Match` header field makes the request method conditional on + the absence of any current representation of the target resource, when + the field-value is `*`, or having a selected representation with an + entity-tag that does not match any of those listed in the field-value. + + :param str if_modified_since: (optional) + The `If-Modified-Since` header field makes a GET or HEAD request method + conditional on the selected representation's modification date being more + recent than the date provided in the field-value. Transfer of the + selected representation's data is avoided if that data has not changed. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.dns.models.TsigKey` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/tsigKeys/{tsigKeyId}" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "if_none_match", + "if_modified_since", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_tsig_key got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "tsigKeyId": tsig_key_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "If-None-Match": kwargs.get("if_none_match", missing), + "If-Modified-Since": kwargs.get("if_modified_since", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="TsigKey") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="TsigKey") + def get_zone(self, zone_name_or_id, **kwargs): """ Gets information about the specified zone, including its creation date, @@ -1400,6 +1842,11 @@ def get_zone(self, zone_name_or_id, **kwargs): recent than the date provided in the field-value. Transfer of the selected representation's data is avoided if that data has not changed. + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. @@ -1422,6 +1869,7 @@ def get_zone(self, zone_name_or_id, **kwargs): "retry_strategy", "if_none_match", "if_modified_since", + "opc_request_id", "compartment_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] @@ -1448,7 +1896,8 @@ def get_zone(self, zone_name_or_id, **kwargs): "accept": "application/json", "content-type": "application/json", "If-None-Match": kwargs.get("if_none_match", missing), - "If-Modified-Since": kwargs.get("if_modified_since", missing) + "If-Modified-Since": kwargs.get("if_modified_since", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -1498,6 +1947,11 @@ def get_zone_records(self, zone_name_or_id, **kwargs): recent than the date provided in the field-value. Transfer of the selected representation's data is avoided if that data has not changed. + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param int limit: (optional) The maximum number of items to return in a page of the collection. @@ -1553,6 +2007,7 @@ def get_zone_records(self, zone_name_or_id, **kwargs): "retry_strategy", "if_none_match", "if_modified_since", + "opc_request_id", "limit", "page", "zone_version", @@ -1609,7 +2064,8 @@ def get_zone_records(self, zone_name_or_id, **kwargs): "accept": "application/json", "content-type": "application/json", "If-None-Match": kwargs.get("if_none_match", missing), - "If-Modified-Since": kwargs.get("if_modified_since", missing) + "If-Modified-Since": kwargs.get("if_modified_since", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -1643,6 +2099,11 @@ def list_steering_policies(self, compartment_id, **kwargs): :param str compartment_id: (required) The OCID of the compartment the resource belongs to. + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param int limit: (optional) The maximum number of items to return in a page of the collection. @@ -1711,6 +2172,7 @@ def list_steering_policies(self, compartment_id, **kwargs): # Don't accept unknown kwargs expected_kwargs = [ "retry_strategy", + "opc_request_id", "limit", "page", "id", @@ -1769,8 +2231,10 @@ def list_steering_policies(self, compartment_id, **kwargs): header_params = { "accept": "application/json", - "content-type": "application/json" + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} retry_strategy = self.retry_strategy if kwargs.get('retry_strategy'): @@ -1800,6 +2264,11 @@ def list_steering_policy_attachments(self, compartment_id, **kwargs): :param str compartment_id: (required) The OCID of the compartment the resource belongs to. + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param int limit: (optional) The maximum number of items to return in a page of the collection. @@ -1872,6 +2341,7 @@ def list_steering_policy_attachments(self, compartment_id, **kwargs): # Don't accept unknown kwargs expected_kwargs = [ "retry_strategy", + "opc_request_id", "limit", "page", "id", @@ -1932,8 +2402,10 @@ def list_steering_policy_attachments(self, compartment_id, **kwargs): header_params = { "accept": "application/json", - "content-type": "application/json" + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} retry_strategy = self.retry_strategy if kwargs.get('retry_strategy'): @@ -1955,6 +2427,137 @@ def list_steering_policy_attachments(self, compartment_id, **kwargs): header_params=header_params, response_type="list[SteeringPolicyAttachmentSummary]") + def list_tsig_keys(self, compartment_id, **kwargs): + """ + Gets a list of all TSIG keys in the specified compartment. + + + :param str compartment_id: (required) + The OCID of the compartment the resource belongs to. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + + :param int limit: (optional) + The maximum number of items to return in a page of the collection. + + :param str page: (optional) + The value of the `opc-next-page` response header from the previous \"List\" call. + + :param str id: (optional) + The OCID of a resource. + + :param str name: (optional) + The name of a resource. + + :param str lifecycle_state: (optional) + The state of a resource. + + Allowed values are: "ACTIVE", "CREATING" + + :param str sort_by: (optional) + The field by which to sort TSIG keys. If unspecified, defaults to `timeCreated`. + + Allowed values are: "name", "timeCreated" + + :param str sort_order: (optional) + The order to sort the resources. + + Allowed values are: "ASC", "DESC" + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.dns.models.TsigKeySummary` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/tsigKeys" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id", + "limit", + "page", + "id", + "name", + "lifecycle_state", + "sort_by", + "sort_order" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_tsig_keys got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["ACTIVE", "CREATING"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["name", "timeCreated"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "compartmentId": compartment_id, + "id": kwargs.get("id", missing), + "name": kwargs.get("name", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="list[TsigKeySummary]") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="list[TsigKeySummary]") + def list_zones(self, compartment_id, **kwargs): """ Gets a list of all zones in the specified compartment. The collection @@ -1964,6 +2567,11 @@ def list_zones(self, compartment_id, **kwargs): :param str compartment_id: (required) The OCID of the compartment the resource belongs to. + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param int limit: (optional) The maximum number of items to return in a page of the collection. @@ -2028,6 +2636,7 @@ def list_zones(self, compartment_id, **kwargs): # Don't accept unknown kwargs expected_kwargs = [ "retry_strategy", + "opc_request_id", "limit", "page", "name", @@ -2089,8 +2698,10 @@ def list_zones(self, compartment_id, **kwargs): header_params = { "accept": "application/json", - "content-type": "application/json" + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} retry_strategy = self.retry_strategy if kwargs.get('retry_strategy'): @@ -2143,6 +2754,11 @@ def patch_domain_records(self, zone_name_or_id, domain, patch_domain_records_det field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation. + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. @@ -2165,6 +2781,7 @@ def patch_domain_records(self, zone_name_or_id, domain, patch_domain_records_det "retry_strategy", "if_match", "if_unmodified_since", + "opc_request_id", "compartment_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] @@ -2192,7 +2809,8 @@ def patch_domain_records(self, zone_name_or_id, domain, patch_domain_records_det "accept": "application/json", "content-type": "application/json", "If-Match": kwargs.get("if_match", missing), - "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing) + "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -2251,6 +2869,11 @@ def patch_rr_set(self, zone_name_or_id, domain, rtype, patch_rr_set_details, **k field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation. + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. @@ -2273,6 +2896,7 @@ def patch_rr_set(self, zone_name_or_id, domain, rtype, patch_rr_set_details, **k "retry_strategy", "if_match", "if_unmodified_since", + "opc_request_id", "compartment_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] @@ -2301,7 +2925,8 @@ def patch_rr_set(self, zone_name_or_id, domain, rtype, patch_rr_set_details, **k "accept": "application/json", "content-type": "application/json", "If-Match": kwargs.get("if_match", missing), - "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing) + "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -2357,6 +2982,11 @@ def patch_zone_records(self, zone_name_or_id, patch_zone_records_details, **kwar field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation. + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. @@ -2379,6 +3009,7 @@ def patch_zone_records(self, zone_name_or_id, patch_zone_records_details, **kwar "retry_strategy", "if_match", "if_unmodified_since", + "opc_request_id", "compartment_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] @@ -2405,7 +3036,8 @@ def patch_zone_records(self, zone_name_or_id, patch_zone_records_details, **kwar "accept": "application/json", "content-type": "application/json", "If-Match": kwargs.get("if_match", missing), - "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing) + "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -2466,6 +3098,11 @@ def update_domain_records(self, zone_name_or_id, domain, update_domain_records_d field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation. + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. @@ -2488,6 +3125,7 @@ def update_domain_records(self, zone_name_or_id, domain, update_domain_records_d "retry_strategy", "if_match", "if_unmodified_since", + "opc_request_id", "compartment_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] @@ -2515,7 +3153,8 @@ def update_domain_records(self, zone_name_or_id, domain, update_domain_records_d "accept": "application/json", "content-type": "application/json", "If-Match": kwargs.get("if_match", missing), - "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing) + "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -2574,6 +3213,11 @@ def update_rr_set(self, zone_name_or_id, domain, rtype, update_rr_set_details, * field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation. + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. @@ -2596,6 +3240,7 @@ def update_rr_set(self, zone_name_or_id, domain, rtype, update_rr_set_details, * "retry_strategy", "if_match", "if_unmodified_since", + "opc_request_id", "compartment_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] @@ -2624,7 +3269,8 @@ def update_rr_set(self, zone_name_or_id, domain, rtype, update_rr_set_details, * "accept": "application/json", "content-type": "application/json", "If-Match": kwargs.get("if_match", missing), - "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing) + "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -2677,6 +3323,11 @@ def update_steering_policy(self, steering_policy_id, update_steering_policy_deta field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation. + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -2695,7 +3346,8 @@ def update_steering_policy(self, steering_policy_id, update_steering_policy_deta expected_kwargs = [ "retry_strategy", "if_match", - "if_unmodified_since" + "if_unmodified_since", + "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -2716,7 +3368,8 @@ def update_steering_policy(self, steering_policy_id, update_steering_policy_deta "accept": "application/json", "content-type": "application/json", "If-Match": kwargs.get("if_match", missing), - "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing) + "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -2767,6 +3420,11 @@ def update_steering_policy_attachment(self, steering_policy_attachment_id, updat field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation. + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -2785,7 +3443,8 @@ def update_steering_policy_attachment(self, steering_policy_attachment_id, updat expected_kwargs = [ "retry_strategy", "if_match", - "if_unmodified_since" + "if_unmodified_since", + "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -2806,7 +3465,8 @@ def update_steering_policy_attachment(self, steering_policy_attachment_id, updat "accept": "application/json", "content-type": "application/json", "If-Match": kwargs.get("if_match", missing), - "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing) + "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -2832,6 +3492,103 @@ def update_steering_policy_attachment(self, steering_policy_attachment_id, updat body=update_steering_policy_attachment_details, response_type="SteeringPolicyAttachment") + def update_tsig_key(self, tsig_key_id, update_tsig_key_details, **kwargs): + """ + Updates the specified TSIG key. + + + :param str tsig_key_id: (required) + The OCID of the target TSIG key. + + :param UpdateTsigKeyDetails update_tsig_key_details: (required) + New data for the TSIG key. + + :param str if_match: (optional) + The `If-Match` header field makes the request method conditional on the + existence of at least one current representation of the target resource, + when the field-value is `*`, or having a current representation of the + target resource that has an entity-tag matching a member of the list of + entity-tags provided in the field-value. + + :param str if_unmodified_since: (optional) + The `If-Unmodified-Since` header field makes the request method + conditional on the selected representation's last modification date being + earlier than or equal to the date provided in the field-value. This + field accomplishes the same purpose as If-Match for cases where the user + agent does not have an entity-tag for the representation. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.dns.models.TsigKey` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/tsigKeys/{tsigKeyId}" + method = "PUT" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "if_match", + "if_unmodified_since", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "update_tsig_key got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "tsigKeyId": tsig_key_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "If-Match": kwargs.get("if_match", missing), + "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_tsig_key_details, + response_type="TsigKey") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_tsig_key_details, + response_type="TsigKey") + def update_zone(self, zone_name_or_id, update_zone_details, **kwargs): """ Updates the specified secondary zone with your new external master @@ -2861,6 +3618,11 @@ def update_zone(self, zone_name_or_id, update_zone_details, **kwargs): field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation. + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. @@ -2883,6 +3645,7 @@ def update_zone(self, zone_name_or_id, update_zone_details, **kwargs): "retry_strategy", "if_match", "if_unmodified_since", + "opc_request_id", "compartment_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] @@ -2909,7 +3672,8 @@ def update_zone(self, zone_name_or_id, update_zone_details, **kwargs): "accept": "application/json", "content-type": "application/json", "If-Match": kwargs.get("if_match", missing), - "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing) + "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -2966,6 +3730,11 @@ def update_zone_records(self, zone_name_or_id, update_zone_records_details, **kw field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation. + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + :param str compartment_id: (optional) The OCID of the compartment the resource belongs to. @@ -2988,6 +3757,7 @@ def update_zone_records(self, zone_name_or_id, update_zone_records_details, **kw "retry_strategy", "if_match", "if_unmodified_since", + "opc_request_id", "compartment_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] @@ -3014,7 +3784,8 @@ def update_zone_records(self, zone_name_or_id, update_zone_records_details, **kw "accept": "application/json", "content-type": "application/json", "If-Match": kwargs.get("if_match", missing), - "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing) + "If-Unmodified-Since": kwargs.get("if_unmodified_since", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} diff --git a/src/oci/dns/dns_client_composite_operations.py b/src/oci/dns/dns_client_composite_operations.py index 82aa85a41d..1cc13e4f2b 100644 --- a/src/oci/dns/dns_client_composite_operations.py +++ b/src/oci/dns/dns_client_composite_operations.py @@ -98,6 +98,44 @@ def create_steering_policy_attachment_and_wait_for_state(self, create_steering_p except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def create_tsig_key_and_wait_for_state(self, create_tsig_key_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.dns.DnsClient.create_tsig_key` and waits for the :py:class:`~oci.dns.models.TsigKey` acted upon + to enter the given state(s). + + :param CreateTsigKeyDetails create_tsig_key_details: (required) + Details for creating a new TSIG key. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.dns.models.TsigKey.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.dns.DnsClient.create_tsig_key` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.create_tsig_key(create_tsig_key_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_tsig_key(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def create_zone_and_wait_for_state(self, create_zone_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.dns.DnsClient.create_zone` and waits for the :py:class:`~oci.dns.models.Zone` acted upon @@ -230,6 +268,53 @@ def delete_steering_policy_attachment_and_wait_for_state(self, steering_policy_a except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def delete_tsig_key_and_wait_for_state(self, tsig_key_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.dns.DnsClient.delete_tsig_key` and waits for the :py:class:`~oci.dns.models.TsigKey` acted upon + to enter the given state(s). + + :param str tsig_key_id: (required) + The OCID of the target TSIG key. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.dns.models.TsigKey.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.dns.DnsClient.delete_tsig_key` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + initial_get_result = self.client.get_tsig_key(tsig_key_id) + operation_result = None + try: + operation_result = self.client.delete_tsig_key(tsig_key_id, **operation_kwargs) + except oci.exceptions.ServiceError as e: + if e.status == 404: + return WAIT_RESOURCE_NOT_FOUND + else: + raise e + + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + + try: + waiter_result = oci.wait_until( + self.client, + initial_get_result, + evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states, + succeed_on_not_found=True, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def delete_zone_and_wait_for_state(self, zone_name_or_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.dns.DnsClient.delete_zone` and waits for the :py:class:`~oci.dns.models.Zone` acted upon @@ -359,6 +444,47 @@ def update_steering_policy_attachment_and_wait_for_state(self, steering_policy_a except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def update_tsig_key_and_wait_for_state(self, tsig_key_id, update_tsig_key_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.dns.DnsClient.update_tsig_key` and waits for the :py:class:`~oci.dns.models.TsigKey` acted upon + to enter the given state(s). + + :param str tsig_key_id: (required) + The OCID of the target TSIG key. + + :param UpdateTsigKeyDetails update_tsig_key_details: (required) + New data for the TSIG key. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.dns.models.TsigKey.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.dns.DnsClient.update_tsig_key` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.update_tsig_key(tsig_key_id, update_tsig_key_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_tsig_key(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def update_zone_and_wait_for_state(self, zone_name_or_id, update_zone_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.dns.DnsClient.update_zone` and waits for the :py:class:`~oci.dns.models.Zone` acted upon diff --git a/src/oci/dns/models/__init__.py b/src/oci/dns/models/__init__.py index 033bea1320..454e8984bd 100644 --- a/src/oci/dns/models/__init__.py +++ b/src/oci/dns/models/__init__.py @@ -4,10 +4,12 @@ from __future__ import absolute_import from .change_steering_policy_compartment_details import ChangeSteeringPolicyCompartmentDetails +from .change_tsig_key_compartment_details import ChangeTsigKeyCompartmentDetails from .change_zone_compartment_details import ChangeZoneCompartmentDetails from .create_migrated_dynect_zone_details import CreateMigratedDynectZoneDetails from .create_steering_policy_attachment_details import CreateSteeringPolicyAttachmentDetails from .create_steering_policy_details import CreateSteeringPolicyDetails +from .create_tsig_key_details import CreateTsigKeyDetails from .create_zone_base_details import CreateZoneBaseDetails from .create_zone_details import CreateZoneDetails from .dynect_migration_details import DynectMigrationDetails @@ -42,10 +44,13 @@ from .steering_policy_weighted_rule import SteeringPolicyWeightedRule from .steering_policy_weighted_rule_case import SteeringPolicyWeightedRuleCase from .tsig import TSIG +from .tsig_key import TsigKey +from .tsig_key_summary import TsigKeySummary from .update_domain_records_details import UpdateDomainRecordsDetails from .update_rr_set_details import UpdateRRSetDetails from .update_steering_policy_attachment_details import UpdateSteeringPolicyAttachmentDetails from .update_steering_policy_details import UpdateSteeringPolicyDetails +from .update_tsig_key_details import UpdateTsigKeyDetails from .update_zone_details import UpdateZoneDetails from .update_zone_records_details import UpdateZoneRecordsDetails from .zone import Zone @@ -54,10 +59,12 @@ # Maps type names to classes for dns services. dns_type_mapping = { "ChangeSteeringPolicyCompartmentDetails": ChangeSteeringPolicyCompartmentDetails, + "ChangeTsigKeyCompartmentDetails": ChangeTsigKeyCompartmentDetails, "ChangeZoneCompartmentDetails": ChangeZoneCompartmentDetails, "CreateMigratedDynectZoneDetails": CreateMigratedDynectZoneDetails, "CreateSteeringPolicyAttachmentDetails": CreateSteeringPolicyAttachmentDetails, "CreateSteeringPolicyDetails": CreateSteeringPolicyDetails, + "CreateTsigKeyDetails": CreateTsigKeyDetails, "CreateZoneBaseDetails": CreateZoneBaseDetails, "CreateZoneDetails": CreateZoneDetails, "DynectMigrationDetails": DynectMigrationDetails, @@ -92,10 +99,13 @@ "SteeringPolicyWeightedRule": SteeringPolicyWeightedRule, "SteeringPolicyWeightedRuleCase": SteeringPolicyWeightedRuleCase, "TSIG": TSIG, + "TsigKey": TsigKey, + "TsigKeySummary": TsigKeySummary, "UpdateDomainRecordsDetails": UpdateDomainRecordsDetails, "UpdateRRSetDetails": UpdateRRSetDetails, "UpdateSteeringPolicyAttachmentDetails": UpdateSteeringPolicyAttachmentDetails, "UpdateSteeringPolicyDetails": UpdateSteeringPolicyDetails, + "UpdateTsigKeyDetails": UpdateTsigKeyDetails, "UpdateZoneDetails": UpdateZoneDetails, "UpdateZoneRecordsDetails": UpdateZoneRecordsDetails, "Zone": Zone, diff --git a/src/oci/integration/models/change_integration_instance_compartment_details.py b/src/oci/dns/models/change_tsig_key_compartment_details.py similarity index 62% rename from src/oci/integration/models/change_integration_instance_compartment_details.py rename to src/oci/dns/models/change_tsig_key_compartment_details.py index 5de03e61ed..917e277a0e 100644 --- a/src/oci/integration/models/change_integration_instance_compartment_details.py +++ b/src/oci/dns/models/change_tsig_key_compartment_details.py @@ -7,18 +7,18 @@ @init_model_state_from_kwargs -class ChangeIntegrationInstanceCompartmentDetails(object): +class ChangeTsigKeyCompartmentDetails(object): """ - The information to be updated. + ChangeTsigKeyCompartmentDetails model. """ def __init__(self, **kwargs): """ - Initializes a new ChangeIntegrationInstanceCompartmentDetails object with values from keyword arguments. + Initializes a new ChangeTsigKeyCompartmentDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class): :param compartment_id: - The value to assign to the compartment_id property of this ChangeIntegrationInstanceCompartmentDetails. + The value to assign to the compartment_id property of this ChangeTsigKeyCompartmentDetails. :type compartment_id: str """ @@ -35,11 +35,14 @@ def __init__(self, **kwargs): @property def compartment_id(self): """ - Gets the compartment_id of this ChangeIntegrationInstanceCompartmentDetails. - Compartment Identifier. + **[Required]** Gets the compartment_id of this ChangeTsigKeyCompartmentDetails. + The `OCID`__ of the compartment + into which the TSIG key should be moved. + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm - :return: The compartment_id of this ChangeIntegrationInstanceCompartmentDetails. + + :return: The compartment_id of this ChangeTsigKeyCompartmentDetails. :rtype: str """ return self._compartment_id @@ -47,11 +50,14 @@ def compartment_id(self): @compartment_id.setter def compartment_id(self, compartment_id): """ - Sets the compartment_id of this ChangeIntegrationInstanceCompartmentDetails. - Compartment Identifier. + Sets the compartment_id of this ChangeTsigKeyCompartmentDetails. + The `OCID`__ of the compartment + into which the TSIG key should be moved. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm - :param compartment_id: The compartment_id of this ChangeIntegrationInstanceCompartmentDetails. + :param compartment_id: The compartment_id of this ChangeTsigKeyCompartmentDetails. :type: str """ self._compartment_id = compartment_id diff --git a/src/oci/dns/models/create_tsig_key_details.py b/src/oci/dns/models/create_tsig_key_details.py new file mode 100644 index 0000000000..4768f45aef --- /dev/null +++ b/src/oci/dns/models/create_tsig_key_details.py @@ -0,0 +1,260 @@ +# coding: utf-8 +# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateTsigKeyDetails(object): + """ + The body for defining a TSIG key. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateTsigKeyDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param algorithm: + The value to assign to the algorithm property of this CreateTsigKeyDetails. + :type algorithm: str + + :param name: + The value to assign to the name property of this CreateTsigKeyDetails. + :type name: str + + :param compartment_id: + The value to assign to the compartment_id property of this CreateTsigKeyDetails. + :type compartment_id: str + + :param secret: + The value to assign to the secret property of this CreateTsigKeyDetails. + :type secret: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateTsigKeyDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateTsigKeyDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'algorithm': 'str', + 'name': 'str', + 'compartment_id': 'str', + 'secret': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'algorithm': 'algorithm', + 'name': 'name', + 'compartment_id': 'compartmentId', + 'secret': 'secret', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._algorithm = None + self._name = None + self._compartment_id = None + self._secret = None + self._freeform_tags = None + self._defined_tags = None + + @property + def algorithm(self): + """ + **[Required]** Gets the algorithm of this CreateTsigKeyDetails. + TSIG key algorithms are encoded as domain names, but most consist of only one + non-empty label, which is not required to be explicitly absolute. + Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, + hmac-sha512. For more information on these algorithms, see `RFC 4635`__. + + __ https://tools.ietf.org/html/rfc4635#section-2 + + + :return: The algorithm of this CreateTsigKeyDetails. + :rtype: str + """ + return self._algorithm + + @algorithm.setter + def algorithm(self, algorithm): + """ + Sets the algorithm of this CreateTsigKeyDetails. + TSIG key algorithms are encoded as domain names, but most consist of only one + non-empty label, which is not required to be explicitly absolute. + Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, + hmac-sha512. For more information on these algorithms, see `RFC 4635`__. + + __ https://tools.ietf.org/html/rfc4635#section-2 + + + :param algorithm: The algorithm of this CreateTsigKeyDetails. + :type: str + """ + self._algorithm = algorithm + + @property + def name(self): + """ + **[Required]** Gets the name of this CreateTsigKeyDetails. + A globally unique domain name identifying the key for a given pair of hosts. + + + :return: The name of this CreateTsigKeyDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this CreateTsigKeyDetails. + A globally unique domain name identifying the key for a given pair of hosts. + + + :param name: The name of this CreateTsigKeyDetails. + :type: str + """ + self._name = name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this CreateTsigKeyDetails. + The OCID of the compartment containing the TSIG key. + + + :return: The compartment_id of this CreateTsigKeyDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateTsigKeyDetails. + The OCID of the compartment containing the TSIG key. + + + :param compartment_id: The compartment_id of this CreateTsigKeyDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def secret(self): + """ + **[Required]** Gets the secret of this CreateTsigKeyDetails. + A base64 string encoding the binary shared secret. + + + :return: The secret of this CreateTsigKeyDetails. + :rtype: str + """ + return self._secret + + @secret.setter + def secret(self, secret): + """ + Sets the secret of this CreateTsigKeyDetails. + A base64 string encoding the binary shared secret. + + + :param secret: The secret of this CreateTsigKeyDetails. + :type: str + """ + self._secret = secret + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateTsigKeyDetails. + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + For more information, see `Resource Tags`__. + + + **Example:** `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :return: The freeform_tags of this CreateTsigKeyDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateTsigKeyDetails. + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + For more information, see `Resource Tags`__. + + + **Example:** `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :param freeform_tags: The freeform_tags of this CreateTsigKeyDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateTsigKeyDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see `Resource Tags`__. + + + **Example:** `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :return: The defined_tags of this CreateTsigKeyDetails. + :rtype: dict(str, dict(str, object)) + """ + return self._defined_tags + + @defined_tags.setter + def defined_tags(self, defined_tags): + """ + Sets the defined_tags of this CreateTsigKeyDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see `Resource Tags`__. + + + **Example:** `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :param defined_tags: The defined_tags of this CreateTsigKeyDetails. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/dns/models/external_master.py b/src/oci/dns/models/external_master.py index fecc329d71..d5cf9e45a6 100644 --- a/src/oci/dns/models/external_master.py +++ b/src/oci/dns/models/external_master.py @@ -10,6 +10,8 @@ class ExternalMaster(object): """ An external master name server used as the source of zone data. + May either have a zone-embedded TSIG or reference a TSIG key by OCID, + but not both. """ def __init__(self, **kwargs): @@ -29,22 +31,29 @@ def __init__(self, **kwargs): The value to assign to the tsig property of this ExternalMaster. :type tsig: TSIG + :param tsig_key_id: + The value to assign to the tsig_key_id property of this ExternalMaster. + :type tsig_key_id: str + """ self.swagger_types = { 'address': 'str', 'port': 'int', - 'tsig': 'TSIG' + 'tsig': 'TSIG', + 'tsig_key_id': 'str' } self.attribute_map = { 'address': 'address', 'port': 'port', - 'tsig': 'tsig' + 'tsig': 'tsig', + 'tsig_key_id': 'tsigKeyId' } self._address = None self._port = None self._tsig = None + self._tsig_key_id = None @property def address(self): @@ -116,6 +125,30 @@ def tsig(self, tsig): """ self._tsig = tsig + @property + def tsig_key_id(self): + """ + Gets the tsig_key_id of this ExternalMaster. + The OCID of the TSIG key. + + + :return: The tsig_key_id of this ExternalMaster. + :rtype: str + """ + return self._tsig_key_id + + @tsig_key_id.setter + def tsig_key_id(self, tsig_key_id): + """ + Sets the tsig_key_id of this ExternalMaster. + The OCID of the TSIG key. + + + :param tsig_key_id: The tsig_key_id of this ExternalMaster. + :type: str + """ + self._tsig_key_id = tsig_key_id + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/dns/models/tsig_key.py b/src/oci/dns/models/tsig_key.py new file mode 100644 index 0000000000..93258822e2 --- /dev/null +++ b/src/oci/dns/models/tsig_key.py @@ -0,0 +1,439 @@ +# coding: utf-8 +# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TsigKey(object): + """ + A TSIG key. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + """ + + #: A constant which can be used with the lifecycle_state property of a TsigKey. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a TsigKey. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + def __init__(self, **kwargs): + """ + Initializes a new TsigKey object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param algorithm: + The value to assign to the algorithm property of this TsigKey. + :type algorithm: str + + :param name: + The value to assign to the name property of this TsigKey. + :type name: str + + :param compartment_id: + The value to assign to the compartment_id property of this TsigKey. + :type compartment_id: str + + :param secret: + The value to assign to the secret property of this TsigKey. + :type secret: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this TsigKey. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this TsigKey. + :type defined_tags: dict(str, dict(str, object)) + + :param id: + The value to assign to the id property of this TsigKey. + :type id: str + + :param _self: + The value to assign to the _self property of this TsigKey. + :type _self: str + + :param time_created: + The value to assign to the time_created property of this TsigKey. + :type time_created: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this TsigKey. + Allowed values for this property are: "ACTIVE", "CREATING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param time_updated: + The value to assign to the time_updated property of this TsigKey. + :type time_updated: datetime + + """ + self.swagger_types = { + 'algorithm': 'str', + 'name': 'str', + 'compartment_id': 'str', + 'secret': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'id': 'str', + '_self': 'str', + 'time_created': 'datetime', + 'lifecycle_state': 'str', + 'time_updated': 'datetime' + } + + self.attribute_map = { + 'algorithm': 'algorithm', + 'name': 'name', + 'compartment_id': 'compartmentId', + 'secret': 'secret', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'id': 'id', + '_self': 'self', + 'time_created': 'timeCreated', + 'lifecycle_state': 'lifecycleState', + 'time_updated': 'timeUpdated' + } + + self._algorithm = None + self._name = None + self._compartment_id = None + self._secret = None + self._freeform_tags = None + self._defined_tags = None + self._id = None + self.__self = None + self._time_created = None + self._lifecycle_state = None + self._time_updated = None + + @property + def algorithm(self): + """ + Gets the algorithm of this TsigKey. + TSIG key algorithms are encoded as domain names, but most consist of only one + non-empty label, which is not required to be explicitly absolute. + Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, + hmac-sha512. For more information on these algorithms, see `RFC 4635`__. + + __ https://tools.ietf.org/html/rfc4635#section-2 + + + :return: The algorithm of this TsigKey. + :rtype: str + """ + return self._algorithm + + @algorithm.setter + def algorithm(self, algorithm): + """ + Sets the algorithm of this TsigKey. + TSIG key algorithms are encoded as domain names, but most consist of only one + non-empty label, which is not required to be explicitly absolute. + Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, + hmac-sha512. For more information on these algorithms, see `RFC 4635`__. + + __ https://tools.ietf.org/html/rfc4635#section-2 + + + :param algorithm: The algorithm of this TsigKey. + :type: str + """ + self._algorithm = algorithm + + @property + def name(self): + """ + Gets the name of this TsigKey. + A globally unique domain name identifying the key for a given pair of hosts. + + + :return: The name of this TsigKey. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this TsigKey. + A globally unique domain name identifying the key for a given pair of hosts. + + + :param name: The name of this TsigKey. + :type: str + """ + self._name = name + + @property + def compartment_id(self): + """ + Gets the compartment_id of this TsigKey. + The OCID of the compartment containing the TSIG key. + + + :return: The compartment_id of this TsigKey. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this TsigKey. + The OCID of the compartment containing the TSIG key. + + + :param compartment_id: The compartment_id of this TsigKey. + :type: str + """ + self._compartment_id = compartment_id + + @property + def secret(self): + """ + Gets the secret of this TsigKey. + A base64 string encoding the binary shared secret. + + + :return: The secret of this TsigKey. + :rtype: str + """ + return self._secret + + @secret.setter + def secret(self, secret): + """ + Sets the secret of this TsigKey. + A base64 string encoding the binary shared secret. + + + :param secret: The secret of this TsigKey. + :type: str + """ + self._secret = secret + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this TsigKey. + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + For more information, see `Resource Tags`__. + + + **Example:** `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :return: The freeform_tags of this TsigKey. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this TsigKey. + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + For more information, see `Resource Tags`__. + + + **Example:** `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :param freeform_tags: The freeform_tags of this TsigKey. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this TsigKey. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see `Resource Tags`__. + + + **Example:** `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :return: The defined_tags of this TsigKey. + :rtype: dict(str, dict(str, object)) + """ + return self._defined_tags + + @defined_tags.setter + def defined_tags(self, defined_tags): + """ + Sets the defined_tags of this TsigKey. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see `Resource Tags`__. + + + **Example:** `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :param defined_tags: The defined_tags of this TsigKey. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def id(self): + """ + Gets the id of this TsigKey. + The OCID of the resource. + + + :return: The id of this TsigKey. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this TsigKey. + The OCID of the resource. + + + :param id: The id of this TsigKey. + :type: str + """ + self._id = id + + @property + def _self(self): + """ + Gets the _self of this TsigKey. + The canonical absolute URL of the resource. + + + :return: The _self of this TsigKey. + :rtype: str + """ + return self.__self + + @_self.setter + def _self(self, _self): + """ + Sets the _self of this TsigKey. + The canonical absolute URL of the resource. + + + :param _self: The _self of this TsigKey. + :type: str + """ + self.__self = _self + + @property + def time_created(self): + """ + Gets the time_created of this TsigKey. + The date and time the resource was created, expressed in RFC 3339 timestamp format. + + **Example:** `2016-07-22T17:23:59:60Z` + + + :return: The time_created of this TsigKey. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this TsigKey. + The date and time the resource was created, expressed in RFC 3339 timestamp format. + + **Example:** `2016-07-22T17:23:59:60Z` + + + :param time_created: The time_created of this TsigKey. + :type: datetime + """ + self._time_created = time_created + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this TsigKey. + The current state of the resource. + + Allowed values for this property are: "ACTIVE", "CREATING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this TsigKey. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this TsigKey. + The current state of the resource. + + + :param lifecycle_state: The lifecycle_state of this TsigKey. + :type: str + """ + allowed_values = ["ACTIVE", "CREATING"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def time_updated(self): + """ + Gets the time_updated of this TsigKey. + The date and time the resource was last updated, expressed in RFC 3339 timestamp format. + + **Example:** `2016-07-22T17:23:59:60Z` + + + :return: The time_updated of this TsigKey. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this TsigKey. + The date and time the resource was last updated, expressed in RFC 3339 timestamp format. + + **Example:** `2016-07-22T17:23:59:60Z` + + + :param time_updated: The time_updated of this TsigKey. + :type: datetime + """ + self._time_updated = time_updated + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/dns/models/tsig_key_summary.py b/src/oci/dns/models/tsig_key_summary.py new file mode 100644 index 0000000000..79d1477892 --- /dev/null +++ b/src/oci/dns/models/tsig_key_summary.py @@ -0,0 +1,371 @@ +# coding: utf-8 +# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TsigKeySummary(object): + """ + A TSIG key. + """ + + #: A constant which can be used with the lifecycle_state property of a TsigKeySummary. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a TsigKeySummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + def __init__(self, **kwargs): + """ + Initializes a new TsigKeySummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param algorithm: + The value to assign to the algorithm property of this TsigKeySummary. + :type algorithm: str + + :param name: + The value to assign to the name property of this TsigKeySummary. + :type name: str + + :param compartment_id: + The value to assign to the compartment_id property of this TsigKeySummary. + :type compartment_id: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this TsigKeySummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this TsigKeySummary. + :type defined_tags: dict(str, dict(str, object)) + + :param id: + The value to assign to the id property of this TsigKeySummary. + :type id: str + + :param _self: + The value to assign to the _self property of this TsigKeySummary. + :type _self: str + + :param time_created: + The value to assign to the time_created property of this TsigKeySummary. + :type time_created: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this TsigKeySummary. + Allowed values for this property are: "ACTIVE", "CREATING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + """ + self.swagger_types = { + 'algorithm': 'str', + 'name': 'str', + 'compartment_id': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'id': 'str', + '_self': 'str', + 'time_created': 'datetime', + 'lifecycle_state': 'str' + } + + self.attribute_map = { + 'algorithm': 'algorithm', + 'name': 'name', + 'compartment_id': 'compartmentId', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'id': 'id', + '_self': 'self', + 'time_created': 'timeCreated', + 'lifecycle_state': 'lifecycleState' + } + + self._algorithm = None + self._name = None + self._compartment_id = None + self._freeform_tags = None + self._defined_tags = None + self._id = None + self.__self = None + self._time_created = None + self._lifecycle_state = None + + @property + def algorithm(self): + """ + Gets the algorithm of this TsigKeySummary. + TSIG key algorithms are encoded as domain names, but most consist of only one + non-empty label, which is not required to be explicitly absolute. + Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, + hmac-sha512. For more information on these algorithms, see `RFC 4635`__. + + __ https://tools.ietf.org/html/rfc4635#section-2 + + + :return: The algorithm of this TsigKeySummary. + :rtype: str + """ + return self._algorithm + + @algorithm.setter + def algorithm(self, algorithm): + """ + Sets the algorithm of this TsigKeySummary. + TSIG key algorithms are encoded as domain names, but most consist of only one + non-empty label, which is not required to be explicitly absolute. + Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, + hmac-sha512. For more information on these algorithms, see `RFC 4635`__. + + __ https://tools.ietf.org/html/rfc4635#section-2 + + + :param algorithm: The algorithm of this TsigKeySummary. + :type: str + """ + self._algorithm = algorithm + + @property + def name(self): + """ + Gets the name of this TsigKeySummary. + A globally unique domain name identifying the key for a given pair of hosts. + + + :return: The name of this TsigKeySummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this TsigKeySummary. + A globally unique domain name identifying the key for a given pair of hosts. + + + :param name: The name of this TsigKeySummary. + :type: str + """ + self._name = name + + @property + def compartment_id(self): + """ + Gets the compartment_id of this TsigKeySummary. + The OCID of the compartment containing the TSIG key. + + + :return: The compartment_id of this TsigKeySummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this TsigKeySummary. + The OCID of the compartment containing the TSIG key. + + + :param compartment_id: The compartment_id of this TsigKeySummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this TsigKeySummary. + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + For more information, see `Resource Tags`__. + + + **Example:** `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :return: The freeform_tags of this TsigKeySummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this TsigKeySummary. + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + For more information, see `Resource Tags`__. + + + **Example:** `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :param freeform_tags: The freeform_tags of this TsigKeySummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this TsigKeySummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see `Resource Tags`__. + + + **Example:** `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :return: The defined_tags of this TsigKeySummary. + :rtype: dict(str, dict(str, object)) + """ + return self._defined_tags + + @defined_tags.setter + def defined_tags(self, defined_tags): + """ + Sets the defined_tags of this TsigKeySummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see `Resource Tags`__. + + + **Example:** `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :param defined_tags: The defined_tags of this TsigKeySummary. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def id(self): + """ + Gets the id of this TsigKeySummary. + The OCID of the resource. + + + :return: The id of this TsigKeySummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this TsigKeySummary. + The OCID of the resource. + + + :param id: The id of this TsigKeySummary. + :type: str + """ + self._id = id + + @property + def _self(self): + """ + Gets the _self of this TsigKeySummary. + The canonical absolute URL of the resource. + + + :return: The _self of this TsigKeySummary. + :rtype: str + """ + return self.__self + + @_self.setter + def _self(self, _self): + """ + Sets the _self of this TsigKeySummary. + The canonical absolute URL of the resource. + + + :param _self: The _self of this TsigKeySummary. + :type: str + """ + self.__self = _self + + @property + def time_created(self): + """ + Gets the time_created of this TsigKeySummary. + The date and time the resource was created, expressed in RFC 3339 timestamp format. + + **Example:** `2016-07-22T17:23:59:60Z` + + + :return: The time_created of this TsigKeySummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this TsigKeySummary. + The date and time the resource was created, expressed in RFC 3339 timestamp format. + + **Example:** `2016-07-22T17:23:59:60Z` + + + :param time_created: The time_created of this TsigKeySummary. + :type: datetime + """ + self._time_created = time_created + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this TsigKeySummary. + The current state of the resource. + + Allowed values for this property are: "ACTIVE", "CREATING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this TsigKeySummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this TsigKeySummary. + The current state of the resource. + + + :param lifecycle_state: The lifecycle_state of this TsigKeySummary. + :type: str + """ + allowed_values = ["ACTIVE", "CREATING"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/dns/models/update_tsig_key_details.py b/src/oci/dns/models/update_tsig_key_details.py new file mode 100644 index 0000000000..4c03640eee --- /dev/null +++ b/src/oci/dns/models/update_tsig_key_details.py @@ -0,0 +1,126 @@ +# coding: utf-8 +# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdateTsigKeyDetails(object): + """ + The body for updating a TSIG key. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateTsigKeyDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdateTsigKeyDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdateTsigKeyDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._freeform_tags = None + self._defined_tags = None + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this UpdateTsigKeyDetails. + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + For more information, see `Resource Tags`__. + + + **Example:** `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :return: The freeform_tags of this UpdateTsigKeyDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this UpdateTsigKeyDetails. + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + For more information, see `Resource Tags`__. + + + **Example:** `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :param freeform_tags: The freeform_tags of this UpdateTsigKeyDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this UpdateTsigKeyDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see `Resource Tags`__. + + + **Example:** `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :return: The defined_tags of this UpdateTsigKeyDetails. + :rtype: dict(str, dict(str, object)) + """ + return self._defined_tags + + @defined_tags.setter + def defined_tags(self, defined_tags): + """ + Sets the defined_tags of this UpdateTsigKeyDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see `Resource Tags`__. + + + **Example:** `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm + + + :param defined_tags: The defined_tags of this UpdateTsigKeyDetails. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/integration/__init__.py b/src/oci/integration/__init__.py deleted file mode 100644 index b4301e7656..0000000000 --- a/src/oci/integration/__init__.py +++ /dev/null @@ -1,11 +0,0 @@ -# coding: utf-8 -# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. - -from __future__ import absolute_import - - -from .integration_instance_client import IntegrationInstanceClient -from .integration_instance_client_composite_operations import IntegrationInstanceClientCompositeOperations -from . import models - -__all__ = ["IntegrationInstanceClient", "IntegrationInstanceClientCompositeOperations", "models"] diff --git a/src/oci/integration/integration_instance_client.py b/src/oci/integration/integration_instance_client.py deleted file mode 100644 index 6a2b8b8271..0000000000 --- a/src/oci/integration/integration_instance_client.py +++ /dev/null @@ -1,948 +0,0 @@ -# coding: utf-8 -# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. - -from __future__ import absolute_import - -from oci._vendor import requests # noqa: F401 -from oci._vendor import six - -from oci import retry # noqa: F401 -from oci.base_client import BaseClient -from oci.config import get_config_value_or_default, validate_config -from oci.signer import Signer -from oci.util import Sentinel -from .models import integration_type_mapping -missing = Sentinel("Missing") - - -class IntegrationInstanceClient(object): - """ - Oracle Integration API. - """ - - def __init__(self, config, **kwargs): - """ - Creates a new service client - - :param dict config: - Configuration keys and values as per `SDK and Tool Configuration `__. - The :py:meth:`~oci.config.from_file` method can be used to load configuration from a file. Alternatively, a ``dict`` can be passed. You can validate_config - the dict using :py:meth:`~oci.config.validate_config` - - :param str service_endpoint: (optional) - The endpoint of the service to call using this client. For example ``https://iaas.us-ashburn-1.oraclecloud.com``. If this keyword argument is - not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit - need to specify a service endpoint. - - :param timeout: (optional) - The connection and read timeouts for the client. The default is that the client never times out. This keyword argument can be provided - as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If - a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout. - :type timeout: float or tuple(float, float) - - :param signer: (optional) - The signer to use when signing requests made by the service client. The default is to use a :py:class:`~oci.signer.Signer` based on the values - provided in the config parameter. - - One use case for this parameter is for `Instance Principals authentication `__ - by passing an instance of :py:class:`~oci.auth.signers.InstancePrincipalsSecurityTokenSigner` as the value for this keyword argument - :type signer: :py:class:`~oci.signer.AbstractBaseSigner` - - :param obj retry_strategy: (optional) - A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. - Retry strategies can also be applied at the operation level by passing a ``retry_strategy`` keyword argument as part of calling the operation. - Any value provided at the operation level will override whatever is specified at the client level. - - This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` - is also available. The specifics of the default retry strategy are described `here `__. - """ - validate_config(config, signer=kwargs.get('signer')) - if 'signer' in kwargs: - signer = kwargs['signer'] - else: - signer = Signer( - tenancy=config["tenancy"], - user=config["user"], - fingerprint=config["fingerprint"], - private_key_file_location=config.get("key_file"), - pass_phrase=get_config_value_or_default(config, "pass_phrase"), - private_key_content=config.get("key_content") - ) - - base_client_init_kwargs = { - 'regional_client': True, - 'service_endpoint': kwargs.get('service_endpoint'), - 'timeout': kwargs.get('timeout'), - 'base_path': '/20190131', - 'service_endpoint_template': 'https://integration.{region}.ocp.{secondLevelDomain}', - 'skip_deserialization': kwargs.get('skip_deserialization', False) - } - self.base_client = BaseClient("integration_instance", config, signer, integration_type_mapping, **base_client_init_kwargs) - self.retry_strategy = kwargs.get('retry_strategy') - - def change_integration_instance_compartment(self, integration_instance_id, change_integration_instance_compartment_details, **kwargs): - """ - Change the compartment for an integration instance - Change the compartment for an integration instance - - - :param str integration_instance_id: (required) - Unique Integration Instance identifier. - - :param ChangeIntegrationInstanceCompartmentDetails change_integration_instance_compartment_details: (required) - Details for the update integration instance - - :param str if_match: (optional) - For optimistic concurrency control. In the PUT or DELETE call - for a resource, set the `if-match` parameter to the value of the - etag from a previous GET or POST response for that resource. - The resource will be updated or deleted only if the etag you - provide matches the resource's current etag value. - - :param str opc_request_id: (optional) - The client request ID for tracing. - - :param obj retry_strategy: (optional) - A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - - This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` - is also available. The specifics of the default retry strategy are described `here `__. - - To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. - - :return: A :class:`~oci.response.Response` object with data of type None - :rtype: :class:`~oci.response.Response` - """ - resource_path = "/integrationInstances/{integrationInstanceId}/actions/changeCompartment" - method = "POST" - - # Don't accept unknown kwargs - expected_kwargs = [ - "retry_strategy", - "if_match", - "opc_request_id" - ] - extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] - if extra_kwargs: - raise ValueError( - "change_integration_instance_compartment got unknown kwargs: {!r}".format(extra_kwargs)) - - path_params = { - "integrationInstanceId": integration_instance_id - } - - path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} - - for (k, v) in six.iteritems(path_params): - if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): - raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) - - header_params = { - "accept": "application/json", - "content-type": "application/json", - "if-match": kwargs.get("if_match", missing), - "opc-request-id": kwargs.get("opc_request_id", missing) - } - header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} - - retry_strategy = self.retry_strategy - if kwargs.get('retry_strategy'): - retry_strategy = kwargs.get('retry_strategy') - - if retry_strategy: - return retry_strategy.make_retrying_call( - self.base_client.call_api, - resource_path=resource_path, - method=method, - path_params=path_params, - header_params=header_params, - body=change_integration_instance_compartment_details) - else: - return self.base_client.call_api( - resource_path=resource_path, - method=method, - path_params=path_params, - header_params=header_params, - body=change_integration_instance_compartment_details) - - def create_integration_instance(self, create_integration_instance_details, **kwargs): - """ - Creates a new Integration Instance - Creates a new Integration Instance. - - - :param CreateIntegrationInstanceDetails create_integration_instance_details: (required) - Details for the new Integration Instance. - - :param str opc_retry_token: (optional) - A token that uniquely identifies a request so it can be retried in case - of a timeout or server error without risk of executing that same action - again. Retry tokens expire after 24 hours, but can be invalidated before - then due to conflicting operations. For example, if a resource has been - deleted and purged from the system, then a retry of the original creation - request might be rejected. - - :param str opc_request_id: (optional) - The client request ID for tracing. - - :param obj retry_strategy: (optional) - A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - - This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` - is also available. The specifics of the default retry strategy are described `here `__. - - To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. - - :return: A :class:`~oci.response.Response` object with data of type None - :rtype: :class:`~oci.response.Response` - """ - resource_path = "/integrationInstances" - method = "POST" - - # Don't accept unknown kwargs - expected_kwargs = [ - "retry_strategy", - "opc_retry_token", - "opc_request_id" - ] - extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] - if extra_kwargs: - raise ValueError( - "create_integration_instance got unknown kwargs: {!r}".format(extra_kwargs)) - - header_params = { - "accept": "application/json", - "content-type": "application/json", - "opc-retry-token": kwargs.get("opc_retry_token", missing), - "opc-request-id": kwargs.get("opc_request_id", missing) - } - header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} - - retry_strategy = self.retry_strategy - if kwargs.get('retry_strategy'): - retry_strategy = kwargs.get('retry_strategy') - - if retry_strategy: - if not isinstance(retry_strategy, retry.NoneRetryStrategy): - self.base_client.add_opc_retry_token_if_needed(header_params) - return retry_strategy.make_retrying_call( - self.base_client.call_api, - resource_path=resource_path, - method=method, - header_params=header_params, - body=create_integration_instance_details) - else: - return self.base_client.call_api( - resource_path=resource_path, - method=method, - header_params=header_params, - body=create_integration_instance_details) - - def delete_integration_instance(self, integration_instance_id, **kwargs): - """ - Delete a provisioned Integration Instance - Deletes an Integration Instance resource by identifier. - - - :param str integration_instance_id: (required) - Unique Integration Instance identifier. - - :param str if_match: (optional) - For optimistic concurrency control. In the PUT or DELETE call - for a resource, set the `if-match` parameter to the value of the - etag from a previous GET or POST response for that resource. - The resource will be updated or deleted only if the etag you - provide matches the resource's current etag value. - - :param str opc_request_id: (optional) - The client request ID for tracing. - - :param obj retry_strategy: (optional) - A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - - This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` - is also available. The specifics of the default retry strategy are described `here `__. - - To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. - - :return: A :class:`~oci.response.Response` object with data of type None - :rtype: :class:`~oci.response.Response` - """ - resource_path = "/integrationInstances/{integrationInstanceId}" - method = "DELETE" - - # Don't accept unknown kwargs - expected_kwargs = [ - "retry_strategy", - "if_match", - "opc_request_id" - ] - extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] - if extra_kwargs: - raise ValueError( - "delete_integration_instance got unknown kwargs: {!r}".format(extra_kwargs)) - - path_params = { - "integrationInstanceId": integration_instance_id - } - - path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} - - for (k, v) in six.iteritems(path_params): - if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): - raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) - - header_params = { - "accept": "application/json", - "content-type": "application/json", - "if-match": kwargs.get("if_match", missing), - "opc-request-id": kwargs.get("opc_request_id", missing) - } - header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} - - retry_strategy = self.retry_strategy - if kwargs.get('retry_strategy'): - retry_strategy = kwargs.get('retry_strategy') - - if retry_strategy: - return retry_strategy.make_retrying_call( - self.base_client.call_api, - resource_path=resource_path, - method=method, - path_params=path_params, - header_params=header_params) - else: - return self.base_client.call_api( - resource_path=resource_path, - method=method, - path_params=path_params, - header_params=header_params) - - def get_integration_instance(self, integration_instance_id, **kwargs): - """ - Get Integration Instance - Gets a IntegrationInstance by identifier - - - :param str integration_instance_id: (required) - Unique Integration Instance identifier. - - :param str opc_request_id: (optional) - The client request ID for tracing. - - :param obj retry_strategy: (optional) - A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - - This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` - is also available. The specifics of the default retry strategy are described `here `__. - - To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. - - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.integration.models.IntegrationInstance` - :rtype: :class:`~oci.response.Response` - """ - resource_path = "/integrationInstances/{integrationInstanceId}" - method = "GET" - - # Don't accept unknown kwargs - expected_kwargs = [ - "retry_strategy", - "opc_request_id" - ] - extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] - if extra_kwargs: - raise ValueError( - "get_integration_instance got unknown kwargs: {!r}".format(extra_kwargs)) - - path_params = { - "integrationInstanceId": integration_instance_id - } - - path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} - - for (k, v) in six.iteritems(path_params): - if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): - raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) - - header_params = { - "accept": "application/json", - "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing) - } - header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} - - retry_strategy = self.retry_strategy - if kwargs.get('retry_strategy'): - retry_strategy = kwargs.get('retry_strategy') - - if retry_strategy: - return retry_strategy.make_retrying_call( - self.base_client.call_api, - resource_path=resource_path, - method=method, - path_params=path_params, - header_params=header_params, - response_type="IntegrationInstance") - else: - return self.base_client.call_api( - resource_path=resource_path, - method=method, - path_params=path_params, - header_params=header_params, - response_type="IntegrationInstance") - - def get_work_request(self, work_request_id, **kwargs): - """ - Get Work Request Status - Gets the status of the work request with the given ID. - - - :param str work_request_id: (required) - The ID of the asynchronous request. - - :param str opc_request_id: (optional) - The client request ID for tracing. - - :param obj retry_strategy: (optional) - A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - - This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` - is also available. The specifics of the default retry strategy are described `here `__. - - To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. - - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.integration.models.WorkRequest` - :rtype: :class:`~oci.response.Response` - """ - resource_path = "/workRequests/{workRequestId}" - method = "GET" - - # Don't accept unknown kwargs - expected_kwargs = [ - "retry_strategy", - "opc_request_id" - ] - extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] - if extra_kwargs: - raise ValueError( - "get_work_request got unknown kwargs: {!r}".format(extra_kwargs)) - - path_params = { - "workRequestId": work_request_id - } - - path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} - - for (k, v) in six.iteritems(path_params): - if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): - raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) - - header_params = { - "accept": "application/json", - "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing) - } - header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} - - retry_strategy = self.retry_strategy - if kwargs.get('retry_strategy'): - retry_strategy = kwargs.get('retry_strategy') - - if retry_strategy: - return retry_strategy.make_retrying_call( - self.base_client.call_api, - resource_path=resource_path, - method=method, - path_params=path_params, - header_params=header_params, - response_type="WorkRequest") - else: - return self.base_client.call_api( - resource_path=resource_path, - method=method, - path_params=path_params, - header_params=header_params, - response_type="WorkRequest") - - def list_integration_instances(self, compartment_id, **kwargs): - """ - Gets a list of all Integration Instances in a compartment - Returns a list of Integration Instances. - - - :param str compartment_id: (required) - The ID of the compartment in which to list resources. - - :param str display_name: (optional) - A user-friendly name. Does not have to be unique, and it's changeable. - - Example: `My new resource` - - :param str lifecycle_state: (optional) - Life cycle state to query on. - - Allowed values are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" - - :param int limit: (optional) - The maximum number of items to return. - - :param str page: (optional) - The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. - - :param str sort_order: (optional) - The sort order to use, either 'asc' or 'desc'. - - Allowed values are: "ASC", "DESC" - - :param str sort_by: (optional) - The field to sort by. Only one sort order may be provided. Default order - for TIMECREATED is descending. Default order for DISPLAYNAME is - ascending. If no value is specified TIMECREATED is default. - - Allowed values are: "TIMECREATED", "DISPLAYNAME" - - :param str opc_request_id: (optional) - The client request ID for tracing. - - :param obj retry_strategy: (optional) - A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - - This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` - is also available. The specifics of the default retry strategy are described `here `__. - - To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. - - :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.integration.models.IntegrationInstanceSummary` - :rtype: :class:`~oci.response.Response` - """ - resource_path = "/integrationInstances" - method = "GET" - - # Don't accept unknown kwargs - expected_kwargs = [ - "retry_strategy", - "display_name", - "lifecycle_state", - "limit", - "page", - "sort_order", - "sort_by", - "opc_request_id" - ] - extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] - if extra_kwargs: - raise ValueError( - "list_integration_instances got unknown kwargs: {!r}".format(extra_kwargs)) - - if 'lifecycle_state' in kwargs: - lifecycle_state_allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED"] - if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: - raise ValueError( - "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) - ) - - if 'sort_order' in kwargs: - sort_order_allowed_values = ["ASC", "DESC"] - if kwargs['sort_order'] not in sort_order_allowed_values: - raise ValueError( - "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) - ) - - if 'sort_by' in kwargs: - sort_by_allowed_values = ["TIMECREATED", "DISPLAYNAME"] - if kwargs['sort_by'] not in sort_by_allowed_values: - raise ValueError( - "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) - ) - - query_params = { - "compartmentId": compartment_id, - "displayName": kwargs.get("display_name", missing), - "lifecycleState": kwargs.get("lifecycle_state", missing), - "limit": kwargs.get("limit", missing), - "page": kwargs.get("page", missing), - "sortOrder": kwargs.get("sort_order", missing), - "sortBy": kwargs.get("sort_by", missing) - } - query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} - - header_params = { - "accept": "application/json", - "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing) - } - header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} - - retry_strategy = self.retry_strategy - if kwargs.get('retry_strategy'): - retry_strategy = kwargs.get('retry_strategy') - - if retry_strategy: - return retry_strategy.make_retrying_call( - self.base_client.call_api, - resource_path=resource_path, - method=method, - query_params=query_params, - header_params=header_params, - response_type="list[IntegrationInstanceSummary]") - else: - return self.base_client.call_api( - resource_path=resource_path, - method=method, - query_params=query_params, - header_params=header_params, - response_type="list[IntegrationInstanceSummary]") - - def list_work_request_errors(self, compartment_id, work_request_id, **kwargs): - """ - Get work request errors. - Get the errors of a work request. - - - :param str compartment_id: (required) - The ID of the compartment in which to list resources. - - :param str work_request_id: (required) - The ID of the asynchronous request. - - :param str opc_request_id: (optional) - The client request ID for tracing. - - :param int limit: (optional) - The maximum number of items to return. - - :param str page: (optional) - The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. - - :param obj retry_strategy: (optional) - A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - - This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` - is also available. The specifics of the default retry strategy are described `here `__. - - To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. - - :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.integration.models.WorkRequestError` - :rtype: :class:`~oci.response.Response` - """ - resource_path = "/workRequests/{workRequestId}/errors" - method = "GET" - - # Don't accept unknown kwargs - expected_kwargs = [ - "retry_strategy", - "opc_request_id", - "limit", - "page" - ] - extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] - if extra_kwargs: - raise ValueError( - "list_work_request_errors got unknown kwargs: {!r}".format(extra_kwargs)) - - path_params = { - "workRequestId": work_request_id - } - - path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} - - for (k, v) in six.iteritems(path_params): - if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): - raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) - - query_params = { - "compartmentId": compartment_id, - "limit": kwargs.get("limit", missing), - "page": kwargs.get("page", missing) - } - query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} - - header_params = { - "accept": "application/json", - "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing) - } - header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} - - retry_strategy = self.retry_strategy - if kwargs.get('retry_strategy'): - retry_strategy = kwargs.get('retry_strategy') - - if retry_strategy: - return retry_strategy.make_retrying_call( - self.base_client.call_api, - resource_path=resource_path, - method=method, - path_params=path_params, - query_params=query_params, - header_params=header_params, - response_type="list[WorkRequestError]") - else: - return self.base_client.call_api( - resource_path=resource_path, - method=method, - path_params=path_params, - query_params=query_params, - header_params=header_params, - response_type="list[WorkRequestError]") - - def list_work_request_logs(self, compartment_id, work_request_id, **kwargs): - """ - Get work request logs. - Get the logs of a work request. - - - :param str compartment_id: (required) - The ID of the compartment in which to list resources. - - :param str work_request_id: (required) - The ID of the asynchronous request. - - :param str opc_request_id: (optional) - The client request ID for tracing. - - :param int limit: (optional) - The maximum number of items to return. - - :param str page: (optional) - The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. - - :param obj retry_strategy: (optional) - A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - - This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` - is also available. The specifics of the default retry strategy are described `here `__. - - To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. - - :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.integration.models.WorkRequestLogEntry` - :rtype: :class:`~oci.response.Response` - """ - resource_path = "/workRequests/{workRequestId}/logs" - method = "GET" - - # Don't accept unknown kwargs - expected_kwargs = [ - "retry_strategy", - "opc_request_id", - "limit", - "page" - ] - extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] - if extra_kwargs: - raise ValueError( - "list_work_request_logs got unknown kwargs: {!r}".format(extra_kwargs)) - - path_params = { - "workRequestId": work_request_id - } - - path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} - - for (k, v) in six.iteritems(path_params): - if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): - raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) - - query_params = { - "compartmentId": compartment_id, - "limit": kwargs.get("limit", missing), - "page": kwargs.get("page", missing) - } - query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} - - header_params = { - "accept": "application/json", - "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing) - } - header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} - - retry_strategy = self.retry_strategy - if kwargs.get('retry_strategy'): - retry_strategy = kwargs.get('retry_strategy') - - if retry_strategy: - return retry_strategy.make_retrying_call( - self.base_client.call_api, - resource_path=resource_path, - method=method, - path_params=path_params, - query_params=query_params, - header_params=header_params, - response_type="list[WorkRequestLogEntry]") - else: - return self.base_client.call_api( - resource_path=resource_path, - method=method, - path_params=path_params, - query_params=query_params, - header_params=header_params, - response_type="list[WorkRequestLogEntry]") - - def list_work_requests(self, compartment_id, **kwargs): - """ - List Work Requests - Lists the work requests in a compartment. - - - :param str compartment_id: (required) - The ID of the compartment in which to list resources. - - :param str opc_request_id: (optional) - The client request ID for tracing. - - :param str page: (optional) - The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. - - :param int limit: (optional) - The maximum number of items to return. - - :param str integration_instance_id: (optional) - The Integration Instance identifier to use to filter results - - :param obj retry_strategy: (optional) - A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - - This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` - is also available. The specifics of the default retry strategy are described `here `__. - - To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. - - :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.integration.models.WorkRequestSummary` - :rtype: :class:`~oci.response.Response` - """ - resource_path = "/workRequests" - method = "GET" - - # Don't accept unknown kwargs - expected_kwargs = [ - "retry_strategy", - "opc_request_id", - "page", - "limit", - "integration_instance_id" - ] - extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] - if extra_kwargs: - raise ValueError( - "list_work_requests got unknown kwargs: {!r}".format(extra_kwargs)) - - query_params = { - "compartmentId": compartment_id, - "page": kwargs.get("page", missing), - "limit": kwargs.get("limit", missing), - "integrationInstanceId": kwargs.get("integration_instance_id", missing) - } - query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} - - header_params = { - "accept": "application/json", - "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing) - } - header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} - - retry_strategy = self.retry_strategy - if kwargs.get('retry_strategy'): - retry_strategy = kwargs.get('retry_strategy') - - if retry_strategy: - return retry_strategy.make_retrying_call( - self.base_client.call_api, - resource_path=resource_path, - method=method, - query_params=query_params, - header_params=header_params, - response_type="list[WorkRequestSummary]") - else: - return self.base_client.call_api( - resource_path=resource_path, - method=method, - query_params=query_params, - header_params=header_params, - response_type="list[WorkRequestSummary]") - - def update_integration_instance(self, integration_instance_id, update_integration_instance_details, **kwargs): - """ - Update the Integration Instance identified by the id - Updates the Integration Instance. - - - :param str integration_instance_id: (required) - Unique Integration Instance identifier. - - :param UpdateIntegrationInstanceDetails update_integration_instance_details: (required) - The information to be updated. - - :param str if_match: (optional) - For optimistic concurrency control. In the PUT or DELETE call - for a resource, set the `if-match` parameter to the value of the - etag from a previous GET or POST response for that resource. - The resource will be updated or deleted only if the etag you - provide matches the resource's current etag value. - - :param str opc_request_id: (optional) - The client request ID for tracing. - - :param obj retry_strategy: (optional) - A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - - This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` - is also available. The specifics of the default retry strategy are described `here `__. - - To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. - - :return: A :class:`~oci.response.Response` object with data of type None - :rtype: :class:`~oci.response.Response` - """ - resource_path = "/integrationInstances/{integrationInstanceId}" - method = "PUT" - - # Don't accept unknown kwargs - expected_kwargs = [ - "retry_strategy", - "if_match", - "opc_request_id" - ] - extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] - if extra_kwargs: - raise ValueError( - "update_integration_instance got unknown kwargs: {!r}".format(extra_kwargs)) - - path_params = { - "integrationInstanceId": integration_instance_id - } - - path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} - - for (k, v) in six.iteritems(path_params): - if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): - raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) - - header_params = { - "accept": "application/json", - "content-type": "application/json", - "if-match": kwargs.get("if_match", missing), - "opc-request-id": kwargs.get("opc_request_id", missing) - } - header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} - - retry_strategy = self.retry_strategy - if kwargs.get('retry_strategy'): - retry_strategy = kwargs.get('retry_strategy') - - if retry_strategy: - return retry_strategy.make_retrying_call( - self.base_client.call_api, - resource_path=resource_path, - method=method, - path_params=path_params, - header_params=header_params, - body=update_integration_instance_details) - else: - return self.base_client.call_api( - resource_path=resource_path, - method=method, - path_params=path_params, - header_params=header_params, - body=update_integration_instance_details) diff --git a/src/oci/integration/integration_instance_client_composite_operations.py b/src/oci/integration/integration_instance_client_composite_operations.py deleted file mode 100644 index b476c3e0e7..0000000000 --- a/src/oci/integration/integration_instance_client_composite_operations.py +++ /dev/null @@ -1,189 +0,0 @@ -# coding: utf-8 -# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. - -import oci # noqa: F401 -from oci.util import WAIT_RESOURCE_NOT_FOUND # noqa: F401 - - -class IntegrationInstanceClientCompositeOperations(object): - """ - This class provides a wrapper around :py:class:`~oci.integration.IntegrationInstanceClient` and offers convenience methods - for operations that would otherwise need to be chained together. For example, instead of performing an action - on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource - to enter a given state, you can call a single method in this class to accomplish the same functionality - """ - - def __init__(self, client, **kwargs): - """ - Creates a new IntegrationInstanceClientCompositeOperations object - - :param IntegrationInstanceClient client: - The service client which will be wrapped by this object - """ - self.client = client - - def change_integration_instance_compartment_and_wait_for_state(self, integration_instance_id, change_integration_instance_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): - """ - Calls :py:func:`~oci.integration.IntegrationInstanceClient.change_integration_instance_compartment` and waits for the :py:class:`~oci.integration.models.WorkRequest` - to enter the given state(s). - - :param str integration_instance_id: (required) - Unique Integration Instance identifier. - - :param ChangeIntegrationInstanceCompartmentDetails change_integration_instance_compartment_details: (required) - Details for the update integration instance - - :param list[str] wait_for_states: - An array of states to wait on. These should be valid values for :py:attr:`~oci.integration.models.WorkRequest.status` - - :param dict operation_kwargs: - A dictionary of keyword arguments to pass to :py:func:`~oci.integration.IntegrationInstanceClient.change_integration_instance_compartment` - - :param dict waiter_kwargs: - A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` - as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait - """ - operation_result = self.client.change_integration_instance_compartment(integration_instance_id, change_integration_instance_compartment_details, **operation_kwargs) - if not wait_for_states: - return operation_result - - lowered_wait_for_states = [w.lower() for w in wait_for_states] - wait_for_resource_id = operation_result.headers['opc-work-request-id'] - - try: - waiter_result = oci.wait_until( - self.client, - self.client.get_work_request(wait_for_resource_id), - evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, - **waiter_kwargs - ) - result_to_return = waiter_result - - return result_to_return - except Exception as e: - raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) - - def create_integration_instance_and_wait_for_state(self, create_integration_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): - """ - Calls :py:func:`~oci.integration.IntegrationInstanceClient.create_integration_instance` and waits for the :py:class:`~oci.integration.models.WorkRequest` - to enter the given state(s). - - :param CreateIntegrationInstanceDetails create_integration_instance_details: (required) - Details for the new Integration Instance. - - :param list[str] wait_for_states: - An array of states to wait on. These should be valid values for :py:attr:`~oci.integration.models.WorkRequest.status` - - :param dict operation_kwargs: - A dictionary of keyword arguments to pass to :py:func:`~oci.integration.IntegrationInstanceClient.create_integration_instance` - - :param dict waiter_kwargs: - A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` - as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait - """ - operation_result = self.client.create_integration_instance(create_integration_instance_details, **operation_kwargs) - if not wait_for_states: - return operation_result - - lowered_wait_for_states = [w.lower() for w in wait_for_states] - wait_for_resource_id = operation_result.headers['opc-work-request-id'] - - try: - waiter_result = oci.wait_until( - self.client, - self.client.get_work_request(wait_for_resource_id), - evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, - **waiter_kwargs - ) - result_to_return = waiter_result - - return result_to_return - except Exception as e: - raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) - - def delete_integration_instance_and_wait_for_state(self, integration_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): - """ - Calls :py:func:`~oci.integration.IntegrationInstanceClient.delete_integration_instance` and waits for the :py:class:`~oci.integration.models.WorkRequest` - to enter the given state(s). - - :param str integration_instance_id: (required) - Unique Integration Instance identifier. - - :param list[str] wait_for_states: - An array of states to wait on. These should be valid values for :py:attr:`~oci.integration.models.WorkRequest.status` - - :param dict operation_kwargs: - A dictionary of keyword arguments to pass to :py:func:`~oci.integration.IntegrationInstanceClient.delete_integration_instance` - - :param dict waiter_kwargs: - A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` - as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait - """ - operation_result = None - try: - operation_result = self.client.delete_integration_instance(integration_instance_id, **operation_kwargs) - except oci.exceptions.ServiceError as e: - if e.status == 404: - return WAIT_RESOURCE_NOT_FOUND - else: - raise e - - if not wait_for_states: - return operation_result - - lowered_wait_for_states = [w.lower() for w in wait_for_states] - wait_for_resource_id = operation_result.headers['opc-work-request-id'] - - try: - waiter_result = oci.wait_until( - self.client, - self.client.get_work_request(wait_for_resource_id), - evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, - **waiter_kwargs - ) - result_to_return = waiter_result - - return result_to_return - except Exception as e: - raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) - - def update_integration_instance_and_wait_for_state(self, integration_instance_id, update_integration_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): - """ - Calls :py:func:`~oci.integration.IntegrationInstanceClient.update_integration_instance` and waits for the :py:class:`~oci.integration.models.WorkRequest` - to enter the given state(s). - - :param str integration_instance_id: (required) - Unique Integration Instance identifier. - - :param UpdateIntegrationInstanceDetails update_integration_instance_details: (required) - The information to be updated. - - :param list[str] wait_for_states: - An array of states to wait on. These should be valid values for :py:attr:`~oci.integration.models.WorkRequest.status` - - :param dict operation_kwargs: - A dictionary of keyword arguments to pass to :py:func:`~oci.integration.IntegrationInstanceClient.update_integration_instance` - - :param dict waiter_kwargs: - A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` - as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait - """ - operation_result = self.client.update_integration_instance(integration_instance_id, update_integration_instance_details, **operation_kwargs) - if not wait_for_states: - return operation_result - - lowered_wait_for_states = [w.lower() for w in wait_for_states] - wait_for_resource_id = operation_result.headers['opc-work-request-id'] - - try: - waiter_result = oci.wait_until( - self.client, - self.client.get_work_request(wait_for_resource_id), - evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, - **waiter_kwargs - ) - result_to_return = waiter_result - - return result_to_return - except Exception as e: - raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) diff --git a/src/oci/integration/models/__init__.py b/src/oci/integration/models/__init__.py deleted file mode 100644 index adf217a4c2..0000000000 --- a/src/oci/integration/models/__init__.py +++ /dev/null @@ -1,29 +0,0 @@ -# coding: utf-8 -# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. - -from __future__ import absolute_import - -from .change_integration_instance_compartment_details import ChangeIntegrationInstanceCompartmentDetails -from .create_integration_instance_details import CreateIntegrationInstanceDetails -from .integration_instance import IntegrationInstance -from .integration_instance_summary import IntegrationInstanceSummary -from .update_integration_instance_details import UpdateIntegrationInstanceDetails -from .work_request import WorkRequest -from .work_request_error import WorkRequestError -from .work_request_log_entry import WorkRequestLogEntry -from .work_request_resource import WorkRequestResource -from .work_request_summary import WorkRequestSummary - -# Maps type names to classes for integration services. -integration_type_mapping = { - "ChangeIntegrationInstanceCompartmentDetails": ChangeIntegrationInstanceCompartmentDetails, - "CreateIntegrationInstanceDetails": CreateIntegrationInstanceDetails, - "IntegrationInstance": IntegrationInstance, - "IntegrationInstanceSummary": IntegrationInstanceSummary, - "UpdateIntegrationInstanceDetails": UpdateIntegrationInstanceDetails, - "WorkRequest": WorkRequest, - "WorkRequestError": WorkRequestError, - "WorkRequestLogEntry": WorkRequestLogEntry, - "WorkRequestResource": WorkRequestResource, - "WorkRequestSummary": WorkRequestSummary -} diff --git a/src/oci/integration/models/create_integration_instance_details.py b/src/oci/integration/models/create_integration_instance_details.py deleted file mode 100644 index c6f43bd45f..0000000000 --- a/src/oci/integration/models/create_integration_instance_details.py +++ /dev/null @@ -1,311 +0,0 @@ -# coding: utf-8 -# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. - - -from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 -from oci.decorators import init_model_state_from_kwargs - - -@init_model_state_from_kwargs -class CreateIntegrationInstanceDetails(object): - """ - The information about new IntegrationInstance. - """ - - #: A constant which can be used with the integration_instance_type property of a CreateIntegrationInstanceDetails. - #: This constant has a value of "STANDARD" - INTEGRATION_INSTANCE_TYPE_STANDARD = "STANDARD" - - #: A constant which can be used with the integration_instance_type property of a CreateIntegrationInstanceDetails. - #: This constant has a value of "ENTERPRISE" - INTEGRATION_INSTANCE_TYPE_ENTERPRISE = "ENTERPRISE" - - def __init__(self, **kwargs): - """ - Initializes a new CreateIntegrationInstanceDetails object with values from keyword arguments. - The following keyword arguments are supported (corresponding to the getters/setters of this class): - - :param display_name: - The value to assign to the display_name property of this CreateIntegrationInstanceDetails. - :type display_name: str - - :param compartment_id: - The value to assign to the compartment_id property of this CreateIntegrationInstanceDetails. - :type compartment_id: str - - :param integration_instance_type: - The value to assign to the integration_instance_type property of this CreateIntegrationInstanceDetails. - Allowed values for this property are: "STANDARD", "ENTERPRISE" - :type integration_instance_type: str - - :param freeform_tags: - The value to assign to the freeform_tags property of this CreateIntegrationInstanceDetails. - :type freeform_tags: dict(str, str) - - :param defined_tags: - The value to assign to the defined_tags property of this CreateIntegrationInstanceDetails. - :type defined_tags: dict(str, dict(str, object)) - - :param is_byol: - The value to assign to the is_byol property of this CreateIntegrationInstanceDetails. - :type is_byol: bool - - :param idcs_at: - The value to assign to the idcs_at property of this CreateIntegrationInstanceDetails. - :type idcs_at: str - - :param message_packs: - The value to assign to the message_packs property of this CreateIntegrationInstanceDetails. - :type message_packs: int - - """ - self.swagger_types = { - 'display_name': 'str', - 'compartment_id': 'str', - 'integration_instance_type': 'str', - 'freeform_tags': 'dict(str, str)', - 'defined_tags': 'dict(str, dict(str, object))', - 'is_byol': 'bool', - 'idcs_at': 'str', - 'message_packs': 'int' - } - - self.attribute_map = { - 'display_name': 'displayName', - 'compartment_id': 'compartmentId', - 'integration_instance_type': 'integrationInstanceType', - 'freeform_tags': 'freeformTags', - 'defined_tags': 'definedTags', - 'is_byol': 'isByol', - 'idcs_at': 'idcsAt', - 'message_packs': 'messagePacks' - } - - self._display_name = None - self._compartment_id = None - self._integration_instance_type = None - self._freeform_tags = None - self._defined_tags = None - self._is_byol = None - self._idcs_at = None - self._message_packs = None - - @property - def display_name(self): - """ - **[Required]** Gets the display_name of this CreateIntegrationInstanceDetails. - Integration Instance Identifier. - - - :return: The display_name of this CreateIntegrationInstanceDetails. - :rtype: str - """ - return self._display_name - - @display_name.setter - def display_name(self, display_name): - """ - Sets the display_name of this CreateIntegrationInstanceDetails. - Integration Instance Identifier. - - - :param display_name: The display_name of this CreateIntegrationInstanceDetails. - :type: str - """ - self._display_name = display_name - - @property - def compartment_id(self): - """ - **[Required]** Gets the compartment_id of this CreateIntegrationInstanceDetails. - Compartment Identifier. - - - :return: The compartment_id of this CreateIntegrationInstanceDetails. - :rtype: str - """ - return self._compartment_id - - @compartment_id.setter - def compartment_id(self, compartment_id): - """ - Sets the compartment_id of this CreateIntegrationInstanceDetails. - Compartment Identifier. - - - :param compartment_id: The compartment_id of this CreateIntegrationInstanceDetails. - :type: str - """ - self._compartment_id = compartment_id - - @property - def integration_instance_type(self): - """ - **[Required]** Gets the integration_instance_type of this CreateIntegrationInstanceDetails. - Standard or Enterprise type - - Allowed values for this property are: "STANDARD", "ENTERPRISE" - - - :return: The integration_instance_type of this CreateIntegrationInstanceDetails. - :rtype: str - """ - return self._integration_instance_type - - @integration_instance_type.setter - def integration_instance_type(self, integration_instance_type): - """ - Sets the integration_instance_type of this CreateIntegrationInstanceDetails. - Standard or Enterprise type - - - :param integration_instance_type: The integration_instance_type of this CreateIntegrationInstanceDetails. - :type: str - """ - allowed_values = ["STANDARD", "ENTERPRISE"] - if not value_allowed_none_or_none_sentinel(integration_instance_type, allowed_values): - raise ValueError( - "Invalid value for `integration_instance_type`, must be None or one of {0}" - .format(allowed_values) - ) - self._integration_instance_type = integration_instance_type - - @property - def freeform_tags(self): - """ - Gets the freeform_tags of this CreateIntegrationInstanceDetails. - Simple key-value pair that is applied without any predefined name, - type or scope. Exists for cross-compatibility only. - Example: `{\"bar-key\": \"value\"}` - - - :return: The freeform_tags of this CreateIntegrationInstanceDetails. - :rtype: dict(str, str) - """ - return self._freeform_tags - - @freeform_tags.setter - def freeform_tags(self, freeform_tags): - """ - Sets the freeform_tags of this CreateIntegrationInstanceDetails. - Simple key-value pair that is applied without any predefined name, - type or scope. Exists for cross-compatibility only. - Example: `{\"bar-key\": \"value\"}` - - - :param freeform_tags: The freeform_tags of this CreateIntegrationInstanceDetails. - :type: dict(str, str) - """ - self._freeform_tags = freeform_tags - - @property - def defined_tags(self): - """ - Gets the defined_tags of this CreateIntegrationInstanceDetails. - Usage of predefined tag keys. These predefined keys are scoped to - namespaces. - Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` - - - :return: The defined_tags of this CreateIntegrationInstanceDetails. - :rtype: dict(str, dict(str, object)) - """ - return self._defined_tags - - @defined_tags.setter - def defined_tags(self, defined_tags): - """ - Sets the defined_tags of this CreateIntegrationInstanceDetails. - Usage of predefined tag keys. These predefined keys are scoped to - namespaces. - Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` - - - :param defined_tags: The defined_tags of this CreateIntegrationInstanceDetails. - :type: dict(str, dict(str, object)) - """ - self._defined_tags = defined_tags - - @property - def is_byol(self): - """ - **[Required]** Gets the is_byol of this CreateIntegrationInstanceDetails. - Bring your own license. - - - :return: The is_byol of this CreateIntegrationInstanceDetails. - :rtype: bool - """ - return self._is_byol - - @is_byol.setter - def is_byol(self, is_byol): - """ - Sets the is_byol of this CreateIntegrationInstanceDetails. - Bring your own license. - - - :param is_byol: The is_byol of this CreateIntegrationInstanceDetails. - :type: bool - """ - self._is_byol = is_byol - - @property - def idcs_at(self): - """ - Gets the idcs_at of this CreateIntegrationInstanceDetails. - IDCS Authentication token. This is is required for pre-UCPIS cloud accounts, but not UCPIS, hence not a required parameter - - - :return: The idcs_at of this CreateIntegrationInstanceDetails. - :rtype: str - """ - return self._idcs_at - - @idcs_at.setter - def idcs_at(self, idcs_at): - """ - Sets the idcs_at of this CreateIntegrationInstanceDetails. - IDCS Authentication token. This is is required for pre-UCPIS cloud accounts, but not UCPIS, hence not a required parameter - - - :param idcs_at: The idcs_at of this CreateIntegrationInstanceDetails. - :type: str - """ - self._idcs_at = idcs_at - - @property - def message_packs(self): - """ - **[Required]** Gets the message_packs of this CreateIntegrationInstanceDetails. - The number of configured message packs - - - :return: The message_packs of this CreateIntegrationInstanceDetails. - :rtype: int - """ - return self._message_packs - - @message_packs.setter - def message_packs(self, message_packs): - """ - Sets the message_packs of this CreateIntegrationInstanceDetails. - The number of configured message packs - - - :param message_packs: The message_packs of this CreateIntegrationInstanceDetails. - :type: int - """ - self._message_packs = message_packs - - def __repr__(self): - return formatted_flat_dict(self) - - def __eq__(self, other): - if other is None: - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - return not self == other diff --git a/src/oci/integration/models/integration_instance.py b/src/oci/integration/models/integration_instance.py deleted file mode 100644 index 9182ea18fd..0000000000 --- a/src/oci/integration/models/integration_instance.py +++ /dev/null @@ -1,497 +0,0 @@ -# coding: utf-8 -# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. - - -from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 -from oci.decorators import init_model_state_from_kwargs - - -@init_model_state_from_kwargs -class IntegrationInstance(object): - """ - Description of Integration Instance. - """ - - #: A constant which can be used with the integration_instance_type property of a IntegrationInstance. - #: This constant has a value of "STANDARD" - INTEGRATION_INSTANCE_TYPE_STANDARD = "STANDARD" - - #: A constant which can be used with the integration_instance_type property of a IntegrationInstance. - #: This constant has a value of "ENTERPRISE" - INTEGRATION_INSTANCE_TYPE_ENTERPRISE = "ENTERPRISE" - - #: A constant which can be used with the lifecycle_state property of a IntegrationInstance. - #: This constant has a value of "CREATING" - LIFECYCLE_STATE_CREATING = "CREATING" - - #: A constant which can be used with the lifecycle_state property of a IntegrationInstance. - #: This constant has a value of "UPDATING" - LIFECYCLE_STATE_UPDATING = "UPDATING" - - #: A constant which can be used with the lifecycle_state property of a IntegrationInstance. - #: This constant has a value of "ACTIVE" - LIFECYCLE_STATE_ACTIVE = "ACTIVE" - - #: A constant which can be used with the lifecycle_state property of a IntegrationInstance. - #: This constant has a value of "DELETING" - LIFECYCLE_STATE_DELETING = "DELETING" - - #: A constant which can be used with the lifecycle_state property of a IntegrationInstance. - #: This constant has a value of "DELETED" - LIFECYCLE_STATE_DELETED = "DELETED" - - #: A constant which can be used with the lifecycle_state property of a IntegrationInstance. - #: This constant has a value of "FAILED" - LIFECYCLE_STATE_FAILED = "FAILED" - - def __init__(self, **kwargs): - """ - Initializes a new IntegrationInstance object with values from keyword arguments. - The following keyword arguments are supported (corresponding to the getters/setters of this class): - - :param id: - The value to assign to the id property of this IntegrationInstance. - :type id: str - - :param display_name: - The value to assign to the display_name property of this IntegrationInstance. - :type display_name: str - - :param compartment_id: - The value to assign to the compartment_id property of this IntegrationInstance. - :type compartment_id: str - - :param integration_instance_type: - The value to assign to the integration_instance_type property of this IntegrationInstance. - Allowed values for this property are: "STANDARD", "ENTERPRISE", 'UNKNOWN_ENUM_VALUE'. - Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. - :type integration_instance_type: str - - :param time_created: - The value to assign to the time_created property of this IntegrationInstance. - :type time_created: datetime - - :param time_updated: - The value to assign to the time_updated property of this IntegrationInstance. - :type time_updated: datetime - - :param lifecycle_state: - The value to assign to the lifecycle_state property of this IntegrationInstance. - Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. - Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. - :type lifecycle_state: str - - :param state_message: - The value to assign to the state_message property of this IntegrationInstance. - :type state_message: str - - :param freeform_tags: - The value to assign to the freeform_tags property of this IntegrationInstance. - :type freeform_tags: dict(str, str) - - :param defined_tags: - The value to assign to the defined_tags property of this IntegrationInstance. - :type defined_tags: dict(str, dict(str, object)) - - :param is_byol: - The value to assign to the is_byol property of this IntegrationInstance. - :type is_byol: bool - - :param instance_url: - The value to assign to the instance_url property of this IntegrationInstance. - :type instance_url: str - - :param message_packs: - The value to assign to the message_packs property of this IntegrationInstance. - :type message_packs: int - - """ - self.swagger_types = { - 'id': 'str', - 'display_name': 'str', - 'compartment_id': 'str', - 'integration_instance_type': 'str', - 'time_created': 'datetime', - 'time_updated': 'datetime', - 'lifecycle_state': 'str', - 'state_message': 'str', - 'freeform_tags': 'dict(str, str)', - 'defined_tags': 'dict(str, dict(str, object))', - 'is_byol': 'bool', - 'instance_url': 'str', - 'message_packs': 'int' - } - - self.attribute_map = { - 'id': 'id', - 'display_name': 'displayName', - 'compartment_id': 'compartmentId', - 'integration_instance_type': 'integrationInstanceType', - 'time_created': 'timeCreated', - 'time_updated': 'timeUpdated', - 'lifecycle_state': 'lifecycleState', - 'state_message': 'stateMessage', - 'freeform_tags': 'freeformTags', - 'defined_tags': 'definedTags', - 'is_byol': 'isByol', - 'instance_url': 'instanceUrl', - 'message_packs': 'messagePacks' - } - - self._id = None - self._display_name = None - self._compartment_id = None - self._integration_instance_type = None - self._time_created = None - self._time_updated = None - self._lifecycle_state = None - self._state_message = None - self._freeform_tags = None - self._defined_tags = None - self._is_byol = None - self._instance_url = None - self._message_packs = None - - @property - def id(self): - """ - **[Required]** Gets the id of this IntegrationInstance. - Unique identifier that is immutable on creation. - - - :return: The id of this IntegrationInstance. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this IntegrationInstance. - Unique identifier that is immutable on creation. - - - :param id: The id of this IntegrationInstance. - :type: str - """ - self._id = id - - @property - def display_name(self): - """ - **[Required]** Gets the display_name of this IntegrationInstance. - Integration Instance Identifier, can be renamed. - - - :return: The display_name of this IntegrationInstance. - :rtype: str - """ - return self._display_name - - @display_name.setter - def display_name(self, display_name): - """ - Sets the display_name of this IntegrationInstance. - Integration Instance Identifier, can be renamed. - - - :param display_name: The display_name of this IntegrationInstance. - :type: str - """ - self._display_name = display_name - - @property - def compartment_id(self): - """ - **[Required]** Gets the compartment_id of this IntegrationInstance. - Compartment Identifier. - - - :return: The compartment_id of this IntegrationInstance. - :rtype: str - """ - return self._compartment_id - - @compartment_id.setter - def compartment_id(self, compartment_id): - """ - Sets the compartment_id of this IntegrationInstance. - Compartment Identifier. - - - :param compartment_id: The compartment_id of this IntegrationInstance. - :type: str - """ - self._compartment_id = compartment_id - - @property - def integration_instance_type(self): - """ - **[Required]** Gets the integration_instance_type of this IntegrationInstance. - Standard or Enterprise type - - Allowed values for this property are: "STANDARD", "ENTERPRISE", 'UNKNOWN_ENUM_VALUE'. - Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. - - - :return: The integration_instance_type of this IntegrationInstance. - :rtype: str - """ - return self._integration_instance_type - - @integration_instance_type.setter - def integration_instance_type(self, integration_instance_type): - """ - Sets the integration_instance_type of this IntegrationInstance. - Standard or Enterprise type - - - :param integration_instance_type: The integration_instance_type of this IntegrationInstance. - :type: str - """ - allowed_values = ["STANDARD", "ENTERPRISE"] - if not value_allowed_none_or_none_sentinel(integration_instance_type, allowed_values): - integration_instance_type = 'UNKNOWN_ENUM_VALUE' - self._integration_instance_type = integration_instance_type - - @property - def time_created(self): - """ - Gets the time_created of this IntegrationInstance. - The time the the IntegrationInstance was created. An RFC3339 formatted datetime string. - - - :return: The time_created of this IntegrationInstance. - :rtype: datetime - """ - return self._time_created - - @time_created.setter - def time_created(self, time_created): - """ - Sets the time_created of this IntegrationInstance. - The time the the IntegrationInstance was created. An RFC3339 formatted datetime string. - - - :param time_created: The time_created of this IntegrationInstance. - :type: datetime - """ - self._time_created = time_created - - @property - def time_updated(self): - """ - Gets the time_updated of this IntegrationInstance. - The time the IntegrationInstance was updated. An RFC3339 formatted datetime string. - - - :return: The time_updated of this IntegrationInstance. - :rtype: datetime - """ - return self._time_updated - - @time_updated.setter - def time_updated(self, time_updated): - """ - Sets the time_updated of this IntegrationInstance. - The time the IntegrationInstance was updated. An RFC3339 formatted datetime string. - - - :param time_updated: The time_updated of this IntegrationInstance. - :type: datetime - """ - self._time_updated = time_updated - - @property - def lifecycle_state(self): - """ - Gets the lifecycle_state of this IntegrationInstance. - The current state of the integration instance. - - Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. - Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. - - - :return: The lifecycle_state of this IntegrationInstance. - :rtype: str - """ - return self._lifecycle_state - - @lifecycle_state.setter - def lifecycle_state(self, lifecycle_state): - """ - Sets the lifecycle_state of this IntegrationInstance. - The current state of the integration instance. - - - :param lifecycle_state: The lifecycle_state of this IntegrationInstance. - :type: str - """ - allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED"] - if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): - lifecycle_state = 'UNKNOWN_ENUM_VALUE' - self._lifecycle_state = lifecycle_state - - @property - def state_message(self): - """ - Gets the state_message of this IntegrationInstance. - An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. - - - :return: The state_message of this IntegrationInstance. - :rtype: str - """ - return self._state_message - - @state_message.setter - def state_message(self, state_message): - """ - Sets the state_message of this IntegrationInstance. - An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. - - - :param state_message: The state_message of this IntegrationInstance. - :type: str - """ - self._state_message = state_message - - @property - def freeform_tags(self): - """ - Gets the freeform_tags of this IntegrationInstance. - Simple key-value pair that is applied without any predefined name, - type or scope. Exists for cross-compatibility only. - Example: `{\"bar-key\": \"value\"}` - - - :return: The freeform_tags of this IntegrationInstance. - :rtype: dict(str, str) - """ - return self._freeform_tags - - @freeform_tags.setter - def freeform_tags(self, freeform_tags): - """ - Sets the freeform_tags of this IntegrationInstance. - Simple key-value pair that is applied without any predefined name, - type or scope. Exists for cross-compatibility only. - Example: `{\"bar-key\": \"value\"}` - - - :param freeform_tags: The freeform_tags of this IntegrationInstance. - :type: dict(str, str) - """ - self._freeform_tags = freeform_tags - - @property - def defined_tags(self): - """ - Gets the defined_tags of this IntegrationInstance. - Usage of predefined tag keys. These predefined keys are scoped to - namespaces. - Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` - - - :return: The defined_tags of this IntegrationInstance. - :rtype: dict(str, dict(str, object)) - """ - return self._defined_tags - - @defined_tags.setter - def defined_tags(self, defined_tags): - """ - Sets the defined_tags of this IntegrationInstance. - Usage of predefined tag keys. These predefined keys are scoped to - namespaces. - Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` - - - :param defined_tags: The defined_tags of this IntegrationInstance. - :type: dict(str, dict(str, object)) - """ - self._defined_tags = defined_tags - - @property - def is_byol(self): - """ - **[Required]** Gets the is_byol of this IntegrationInstance. - Bring your own license. - - - :return: The is_byol of this IntegrationInstance. - :rtype: bool - """ - return self._is_byol - - @is_byol.setter - def is_byol(self, is_byol): - """ - Sets the is_byol of this IntegrationInstance. - Bring your own license. - - - :param is_byol: The is_byol of this IntegrationInstance. - :type: bool - """ - self._is_byol = is_byol - - @property - def instance_url(self): - """ - **[Required]** Gets the instance_url of this IntegrationInstance. - The Integration Instance URL. - - - :return: The instance_url of this IntegrationInstance. - :rtype: str - """ - return self._instance_url - - @instance_url.setter - def instance_url(self, instance_url): - """ - Sets the instance_url of this IntegrationInstance. - The Integration Instance URL. - - - :param instance_url: The instance_url of this IntegrationInstance. - :type: str - """ - self._instance_url = instance_url - - @property - def message_packs(self): - """ - **[Required]** Gets the message_packs of this IntegrationInstance. - The number of configured message packs (if any) - - - :return: The message_packs of this IntegrationInstance. - :rtype: int - """ - return self._message_packs - - @message_packs.setter - def message_packs(self, message_packs): - """ - Sets the message_packs of this IntegrationInstance. - The number of configured message packs (if any) - - - :param message_packs: The message_packs of this IntegrationInstance. - :type: int - """ - self._message_packs = message_packs - - def __repr__(self): - return formatted_flat_dict(self) - - def __eq__(self, other): - if other is None: - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - return not self == other diff --git a/src/oci/integration/models/integration_instance_summary.py b/src/oci/integration/models/integration_instance_summary.py deleted file mode 100644 index b76f93a525..0000000000 --- a/src/oci/integration/models/integration_instance_summary.py +++ /dev/null @@ -1,427 +0,0 @@ -# coding: utf-8 -# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. - - -from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 -from oci.decorators import init_model_state_from_kwargs - - -@init_model_state_from_kwargs -class IntegrationInstanceSummary(object): - """ - Summary of the Integration Instance. - """ - - #: A constant which can be used with the integration_instance_type property of a IntegrationInstanceSummary. - #: This constant has a value of "STANDARD" - INTEGRATION_INSTANCE_TYPE_STANDARD = "STANDARD" - - #: A constant which can be used with the integration_instance_type property of a IntegrationInstanceSummary. - #: This constant has a value of "ENTERPRISE" - INTEGRATION_INSTANCE_TYPE_ENTERPRISE = "ENTERPRISE" - - #: A constant which can be used with the lifecycle_state property of a IntegrationInstanceSummary. - #: This constant has a value of "CREATING" - LIFECYCLE_STATE_CREATING = "CREATING" - - #: A constant which can be used with the lifecycle_state property of a IntegrationInstanceSummary. - #: This constant has a value of "UPDATING" - LIFECYCLE_STATE_UPDATING = "UPDATING" - - #: A constant which can be used with the lifecycle_state property of a IntegrationInstanceSummary. - #: This constant has a value of "ACTIVE" - LIFECYCLE_STATE_ACTIVE = "ACTIVE" - - #: A constant which can be used with the lifecycle_state property of a IntegrationInstanceSummary. - #: This constant has a value of "DELETING" - LIFECYCLE_STATE_DELETING = "DELETING" - - #: A constant which can be used with the lifecycle_state property of a IntegrationInstanceSummary. - #: This constant has a value of "DELETED" - LIFECYCLE_STATE_DELETED = "DELETED" - - #: A constant which can be used with the lifecycle_state property of a IntegrationInstanceSummary. - #: This constant has a value of "FAILED" - LIFECYCLE_STATE_FAILED = "FAILED" - - def __init__(self, **kwargs): - """ - Initializes a new IntegrationInstanceSummary object with values from keyword arguments. - The following keyword arguments are supported (corresponding to the getters/setters of this class): - - :param id: - The value to assign to the id property of this IntegrationInstanceSummary. - :type id: str - - :param display_name: - The value to assign to the display_name property of this IntegrationInstanceSummary. - :type display_name: str - - :param compartment_id: - The value to assign to the compartment_id property of this IntegrationInstanceSummary. - :type compartment_id: str - - :param integration_instance_type: - The value to assign to the integration_instance_type property of this IntegrationInstanceSummary. - Allowed values for this property are: "STANDARD", "ENTERPRISE", 'UNKNOWN_ENUM_VALUE'. - Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. - :type integration_instance_type: str - - :param time_created: - The value to assign to the time_created property of this IntegrationInstanceSummary. - :type time_created: datetime - - :param time_updated: - The value to assign to the time_updated property of this IntegrationInstanceSummary. - :type time_updated: datetime - - :param lifecycle_state: - The value to assign to the lifecycle_state property of this IntegrationInstanceSummary. - Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. - Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. - :type lifecycle_state: str - - :param state_message: - The value to assign to the state_message property of this IntegrationInstanceSummary. - :type state_message: str - - :param is_byol: - The value to assign to the is_byol property of this IntegrationInstanceSummary. - :type is_byol: bool - - :param instance_url: - The value to assign to the instance_url property of this IntegrationInstanceSummary. - :type instance_url: str - - :param message_packs: - The value to assign to the message_packs property of this IntegrationInstanceSummary. - :type message_packs: int - - """ - self.swagger_types = { - 'id': 'str', - 'display_name': 'str', - 'compartment_id': 'str', - 'integration_instance_type': 'str', - 'time_created': 'datetime', - 'time_updated': 'datetime', - 'lifecycle_state': 'str', - 'state_message': 'str', - 'is_byol': 'bool', - 'instance_url': 'str', - 'message_packs': 'int' - } - - self.attribute_map = { - 'id': 'id', - 'display_name': 'displayName', - 'compartment_id': 'compartmentId', - 'integration_instance_type': 'integrationInstanceType', - 'time_created': 'timeCreated', - 'time_updated': 'timeUpdated', - 'lifecycle_state': 'lifecycleState', - 'state_message': 'stateMessage', - 'is_byol': 'isByol', - 'instance_url': 'instanceUrl', - 'message_packs': 'messagePacks' - } - - self._id = None - self._display_name = None - self._compartment_id = None - self._integration_instance_type = None - self._time_created = None - self._time_updated = None - self._lifecycle_state = None - self._state_message = None - self._is_byol = None - self._instance_url = None - self._message_packs = None - - @property - def id(self): - """ - **[Required]** Gets the id of this IntegrationInstanceSummary. - Unique identifier that is immutable on creation. - - - :return: The id of this IntegrationInstanceSummary. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this IntegrationInstanceSummary. - Unique identifier that is immutable on creation. - - - :param id: The id of this IntegrationInstanceSummary. - :type: str - """ - self._id = id - - @property - def display_name(self): - """ - **[Required]** Gets the display_name of this IntegrationInstanceSummary. - Integration Instance Identifier, can be renamed. - - - :return: The display_name of this IntegrationInstanceSummary. - :rtype: str - """ - return self._display_name - - @display_name.setter - def display_name(self, display_name): - """ - Sets the display_name of this IntegrationInstanceSummary. - Integration Instance Identifier, can be renamed. - - - :param display_name: The display_name of this IntegrationInstanceSummary. - :type: str - """ - self._display_name = display_name - - @property - def compartment_id(self): - """ - **[Required]** Gets the compartment_id of this IntegrationInstanceSummary. - Compartment Identifier. - - - :return: The compartment_id of this IntegrationInstanceSummary. - :rtype: str - """ - return self._compartment_id - - @compartment_id.setter - def compartment_id(self, compartment_id): - """ - Sets the compartment_id of this IntegrationInstanceSummary. - Compartment Identifier. - - - :param compartment_id: The compartment_id of this IntegrationInstanceSummary. - :type: str - """ - self._compartment_id = compartment_id - - @property - def integration_instance_type(self): - """ - **[Required]** Gets the integration_instance_type of this IntegrationInstanceSummary. - Standard or Enterprise type - - Allowed values for this property are: "STANDARD", "ENTERPRISE", 'UNKNOWN_ENUM_VALUE'. - Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. - - - :return: The integration_instance_type of this IntegrationInstanceSummary. - :rtype: str - """ - return self._integration_instance_type - - @integration_instance_type.setter - def integration_instance_type(self, integration_instance_type): - """ - Sets the integration_instance_type of this IntegrationInstanceSummary. - Standard or Enterprise type - - - :param integration_instance_type: The integration_instance_type of this IntegrationInstanceSummary. - :type: str - """ - allowed_values = ["STANDARD", "ENTERPRISE"] - if not value_allowed_none_or_none_sentinel(integration_instance_type, allowed_values): - integration_instance_type = 'UNKNOWN_ENUM_VALUE' - self._integration_instance_type = integration_instance_type - - @property - def time_created(self): - """ - Gets the time_created of this IntegrationInstanceSummary. - The time the the Integration Instance was created. An RFC3339 formatted datetime string. - - - :return: The time_created of this IntegrationInstanceSummary. - :rtype: datetime - """ - return self._time_created - - @time_created.setter - def time_created(self, time_created): - """ - Sets the time_created of this IntegrationInstanceSummary. - The time the the Integration Instance was created. An RFC3339 formatted datetime string. - - - :param time_created: The time_created of this IntegrationInstanceSummary. - :type: datetime - """ - self._time_created = time_created - - @property - def time_updated(self): - """ - Gets the time_updated of this IntegrationInstanceSummary. - The time the IntegrationInstance was updated. An RFC3339 formatted datetime string. - - - :return: The time_updated of this IntegrationInstanceSummary. - :rtype: datetime - """ - return self._time_updated - - @time_updated.setter - def time_updated(self, time_updated): - """ - Sets the time_updated of this IntegrationInstanceSummary. - The time the IntegrationInstance was updated. An RFC3339 formatted datetime string. - - - :param time_updated: The time_updated of this IntegrationInstanceSummary. - :type: datetime - """ - self._time_updated = time_updated - - @property - def lifecycle_state(self): - """ - Gets the lifecycle_state of this IntegrationInstanceSummary. - The current state of the Integration Instance. - - Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. - Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. - - - :return: The lifecycle_state of this IntegrationInstanceSummary. - :rtype: str - """ - return self._lifecycle_state - - @lifecycle_state.setter - def lifecycle_state(self, lifecycle_state): - """ - Sets the lifecycle_state of this IntegrationInstanceSummary. - The current state of the Integration Instance. - - - :param lifecycle_state: The lifecycle_state of this IntegrationInstanceSummary. - :type: str - """ - allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED"] - if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): - lifecycle_state = 'UNKNOWN_ENUM_VALUE' - self._lifecycle_state = lifecycle_state - - @property - def state_message(self): - """ - Gets the state_message of this IntegrationInstanceSummary. - An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. - - - :return: The state_message of this IntegrationInstanceSummary. - :rtype: str - """ - return self._state_message - - @state_message.setter - def state_message(self, state_message): - """ - Sets the state_message of this IntegrationInstanceSummary. - An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. - - - :param state_message: The state_message of this IntegrationInstanceSummary. - :type: str - """ - self._state_message = state_message - - @property - def is_byol(self): - """ - **[Required]** Gets the is_byol of this IntegrationInstanceSummary. - Bring your own license. - - - :return: The is_byol of this IntegrationInstanceSummary. - :rtype: bool - """ - return self._is_byol - - @is_byol.setter - def is_byol(self, is_byol): - """ - Sets the is_byol of this IntegrationInstanceSummary. - Bring your own license. - - - :param is_byol: The is_byol of this IntegrationInstanceSummary. - :type: bool - """ - self._is_byol = is_byol - - @property - def instance_url(self): - """ - **[Required]** Gets the instance_url of this IntegrationInstanceSummary. - The Integration Instance URL. - - - :return: The instance_url of this IntegrationInstanceSummary. - :rtype: str - """ - return self._instance_url - - @instance_url.setter - def instance_url(self, instance_url): - """ - Sets the instance_url of this IntegrationInstanceSummary. - The Integration Instance URL. - - - :param instance_url: The instance_url of this IntegrationInstanceSummary. - :type: str - """ - self._instance_url = instance_url - - @property - def message_packs(self): - """ - **[Required]** Gets the message_packs of this IntegrationInstanceSummary. - The number of configured message packs (if any) - - - :return: The message_packs of this IntegrationInstanceSummary. - :rtype: int - """ - return self._message_packs - - @message_packs.setter - def message_packs(self, message_packs): - """ - Sets the message_packs of this IntegrationInstanceSummary. - The number of configured message packs (if any) - - - :param message_packs: The message_packs of this IntegrationInstanceSummary. - :type: int - """ - self._message_packs = message_packs - - def __repr__(self): - return formatted_flat_dict(self) - - def __eq__(self, other): - if other is None: - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - return not self == other diff --git a/src/oci/integration/models/update_integration_instance_details.py b/src/oci/integration/models/update_integration_instance_details.py deleted file mode 100644 index c60afa4339..0000000000 --- a/src/oci/integration/models/update_integration_instance_details.py +++ /dev/null @@ -1,249 +0,0 @@ -# coding: utf-8 -# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. - - -from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 -from oci.decorators import init_model_state_from_kwargs - - -@init_model_state_from_kwargs -class UpdateIntegrationInstanceDetails(object): - """ - The information to be updated. - """ - - #: A constant which can be used with the integration_instance_type property of a UpdateIntegrationInstanceDetails. - #: This constant has a value of "STANDARD" - INTEGRATION_INSTANCE_TYPE_STANDARD = "STANDARD" - - #: A constant which can be used with the integration_instance_type property of a UpdateIntegrationInstanceDetails. - #: This constant has a value of "ENTERPRISE" - INTEGRATION_INSTANCE_TYPE_ENTERPRISE = "ENTERPRISE" - - def __init__(self, **kwargs): - """ - Initializes a new UpdateIntegrationInstanceDetails object with values from keyword arguments. - The following keyword arguments are supported (corresponding to the getters/setters of this class): - - :param display_name: - The value to assign to the display_name property of this UpdateIntegrationInstanceDetails. - :type display_name: str - - :param integration_instance_type: - The value to assign to the integration_instance_type property of this UpdateIntegrationInstanceDetails. - Allowed values for this property are: "STANDARD", "ENTERPRISE" - :type integration_instance_type: str - - :param freeform_tags: - The value to assign to the freeform_tags property of this UpdateIntegrationInstanceDetails. - :type freeform_tags: dict(str, str) - - :param defined_tags: - The value to assign to the defined_tags property of this UpdateIntegrationInstanceDetails. - :type defined_tags: dict(str, dict(str, object)) - - :param is_byol: - The value to assign to the is_byol property of this UpdateIntegrationInstanceDetails. - :type is_byol: bool - - :param message_packs: - The value to assign to the message_packs property of this UpdateIntegrationInstanceDetails. - :type message_packs: int - - """ - self.swagger_types = { - 'display_name': 'str', - 'integration_instance_type': 'str', - 'freeform_tags': 'dict(str, str)', - 'defined_tags': 'dict(str, dict(str, object))', - 'is_byol': 'bool', - 'message_packs': 'int' - } - - self.attribute_map = { - 'display_name': 'displayName', - 'integration_instance_type': 'integrationInstanceType', - 'freeform_tags': 'freeformTags', - 'defined_tags': 'definedTags', - 'is_byol': 'isByol', - 'message_packs': 'messagePacks' - } - - self._display_name = None - self._integration_instance_type = None - self._freeform_tags = None - self._defined_tags = None - self._is_byol = None - self._message_packs = None - - @property - def display_name(self): - """ - Gets the display_name of this UpdateIntegrationInstanceDetails. - Integration Instance Identifier. - - - :return: The display_name of this UpdateIntegrationInstanceDetails. - :rtype: str - """ - return self._display_name - - @display_name.setter - def display_name(self, display_name): - """ - Sets the display_name of this UpdateIntegrationInstanceDetails. - Integration Instance Identifier. - - - :param display_name: The display_name of this UpdateIntegrationInstanceDetails. - :type: str - """ - self._display_name = display_name - - @property - def integration_instance_type(self): - """ - Gets the integration_instance_type of this UpdateIntegrationInstanceDetails. - Standard or Enterprise type - - Allowed values for this property are: "STANDARD", "ENTERPRISE" - - - :return: The integration_instance_type of this UpdateIntegrationInstanceDetails. - :rtype: str - """ - return self._integration_instance_type - - @integration_instance_type.setter - def integration_instance_type(self, integration_instance_type): - """ - Sets the integration_instance_type of this UpdateIntegrationInstanceDetails. - Standard or Enterprise type - - - :param integration_instance_type: The integration_instance_type of this UpdateIntegrationInstanceDetails. - :type: str - """ - allowed_values = ["STANDARD", "ENTERPRISE"] - if not value_allowed_none_or_none_sentinel(integration_instance_type, allowed_values): - raise ValueError( - "Invalid value for `integration_instance_type`, must be None or one of {0}" - .format(allowed_values) - ) - self._integration_instance_type = integration_instance_type - - @property - def freeform_tags(self): - """ - Gets the freeform_tags of this UpdateIntegrationInstanceDetails. - Simple key-value pair that is applied without any predefined name, - type or scope. Exists for cross-compatibility only. - Example: `{\"bar-key\": \"value\"}` - - - :return: The freeform_tags of this UpdateIntegrationInstanceDetails. - :rtype: dict(str, str) - """ - return self._freeform_tags - - @freeform_tags.setter - def freeform_tags(self, freeform_tags): - """ - Sets the freeform_tags of this UpdateIntegrationInstanceDetails. - Simple key-value pair that is applied without any predefined name, - type or scope. Exists for cross-compatibility only. - Example: `{\"bar-key\": \"value\"}` - - - :param freeform_tags: The freeform_tags of this UpdateIntegrationInstanceDetails. - :type: dict(str, str) - """ - self._freeform_tags = freeform_tags - - @property - def defined_tags(self): - """ - Gets the defined_tags of this UpdateIntegrationInstanceDetails. - Usage of predefined tag keys. These predefined keys are scoped to - namespaces. - Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` - - - :return: The defined_tags of this UpdateIntegrationInstanceDetails. - :rtype: dict(str, dict(str, object)) - """ - return self._defined_tags - - @defined_tags.setter - def defined_tags(self, defined_tags): - """ - Sets the defined_tags of this UpdateIntegrationInstanceDetails. - Usage of predefined tag keys. These predefined keys are scoped to - namespaces. - Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` - - - :param defined_tags: The defined_tags of this UpdateIntegrationInstanceDetails. - :type: dict(str, dict(str, object)) - """ - self._defined_tags = defined_tags - - @property - def is_byol(self): - """ - Gets the is_byol of this UpdateIntegrationInstanceDetails. - Bring your own license. - - - :return: The is_byol of this UpdateIntegrationInstanceDetails. - :rtype: bool - """ - return self._is_byol - - @is_byol.setter - def is_byol(self, is_byol): - """ - Sets the is_byol of this UpdateIntegrationInstanceDetails. - Bring your own license. - - - :param is_byol: The is_byol of this UpdateIntegrationInstanceDetails. - :type: bool - """ - self._is_byol = is_byol - - @property - def message_packs(self): - """ - Gets the message_packs of this UpdateIntegrationInstanceDetails. - The number of configured message packs - - - :return: The message_packs of this UpdateIntegrationInstanceDetails. - :rtype: int - """ - return self._message_packs - - @message_packs.setter - def message_packs(self, message_packs): - """ - Sets the message_packs of this UpdateIntegrationInstanceDetails. - The number of configured message packs - - - :param message_packs: The message_packs of this UpdateIntegrationInstanceDetails. - :type: int - """ - self._message_packs = message_packs - - def __repr__(self): - return formatted_flat_dict(self) - - def __eq__(self, other): - if other is None: - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - return not self == other diff --git a/src/oci/integration/models/work_request.py b/src/oci/integration/models/work_request.py deleted file mode 100644 index 8175362e44..0000000000 --- a/src/oci/integration/models/work_request.py +++ /dev/null @@ -1,399 +0,0 @@ -# coding: utf-8 -# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. - - -from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 -from oci.decorators import init_model_state_from_kwargs - - -@init_model_state_from_kwargs -class WorkRequest(object): - """ - A description of work request status. - """ - - #: A constant which can be used with the operation_type property of a WorkRequest. - #: This constant has a value of "CREATE_INTEGRATION_INSTANCE" - OPERATION_TYPE_CREATE_INTEGRATION_INSTANCE = "CREATE_INTEGRATION_INSTANCE" - - #: A constant which can be used with the operation_type property of a WorkRequest. - #: This constant has a value of "UPDATE_INTEGRATION_INSTANCE" - OPERATION_TYPE_UPDATE_INTEGRATION_INSTANCE = "UPDATE_INTEGRATION_INSTANCE" - - #: A constant which can be used with the operation_type property of a WorkRequest. - #: This constant has a value of "DELETE_INTEGRATION_INSTANCE" - OPERATION_TYPE_DELETE_INTEGRATION_INSTANCE = "DELETE_INTEGRATION_INSTANCE" - - #: A constant which can be used with the status property of a WorkRequest. - #: This constant has a value of "ACCEPTED" - STATUS_ACCEPTED = "ACCEPTED" - - #: A constant which can be used with the status property of a WorkRequest. - #: This constant has a value of "IN_PROGRESS" - STATUS_IN_PROGRESS = "IN_PROGRESS" - - #: A constant which can be used with the status property of a WorkRequest. - #: This constant has a value of "FAILED" - STATUS_FAILED = "FAILED" - - #: A constant which can be used with the status property of a WorkRequest. - #: This constant has a value of "SUCCEEDED" - STATUS_SUCCEEDED = "SUCCEEDED" - - #: A constant which can be used with the status property of a WorkRequest. - #: This constant has a value of "CANCELING" - STATUS_CANCELING = "CANCELING" - - #: A constant which can be used with the status property of a WorkRequest. - #: This constant has a value of "CANCELED" - STATUS_CANCELED = "CANCELED" - - def __init__(self, **kwargs): - """ - Initializes a new WorkRequest object with values from keyword arguments. - The following keyword arguments are supported (corresponding to the getters/setters of this class): - - :param operation_type: - The value to assign to the operation_type property of this WorkRequest. - Allowed values for this property are: "CREATE_INTEGRATION_INSTANCE", "UPDATE_INTEGRATION_INSTANCE", "DELETE_INTEGRATION_INSTANCE", 'UNKNOWN_ENUM_VALUE'. - Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. - :type operation_type: str - - :param status: - The value to assign to the status property of this WorkRequest. - Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED", 'UNKNOWN_ENUM_VALUE'. - Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. - :type status: str - - :param id: - The value to assign to the id property of this WorkRequest. - :type id: str - - :param compartment_id: - The value to assign to the compartment_id property of this WorkRequest. - :type compartment_id: str - - :param resources: - The value to assign to the resources property of this WorkRequest. - :type resources: list[WorkRequestResource] - - :param percent_complete: - The value to assign to the percent_complete property of this WorkRequest. - :type percent_complete: float - - :param time_accepted: - The value to assign to the time_accepted property of this WorkRequest. - :type time_accepted: datetime - - :param time_started: - The value to assign to the time_started property of this WorkRequest. - :type time_started: datetime - - :param time_finished: - The value to assign to the time_finished property of this WorkRequest. - :type time_finished: datetime - - """ - self.swagger_types = { - 'operation_type': 'str', - 'status': 'str', - 'id': 'str', - 'compartment_id': 'str', - 'resources': 'list[WorkRequestResource]', - 'percent_complete': 'float', - 'time_accepted': 'datetime', - 'time_started': 'datetime', - 'time_finished': 'datetime' - } - - self.attribute_map = { - 'operation_type': 'operationType', - 'status': 'status', - 'id': 'id', - 'compartment_id': 'compartmentId', - 'resources': 'resources', - 'percent_complete': 'percentComplete', - 'time_accepted': 'timeAccepted', - 'time_started': 'timeStarted', - 'time_finished': 'timeFinished' - } - - self._operation_type = None - self._status = None - self._id = None - self._compartment_id = None - self._resources = None - self._percent_complete = None - self._time_accepted = None - self._time_started = None - self._time_finished = None - - @property - def operation_type(self): - """ - **[Required]** Gets the operation_type of this WorkRequest. - Type of the work request. - - Allowed values for this property are: "CREATE_INTEGRATION_INSTANCE", "UPDATE_INTEGRATION_INSTANCE", "DELETE_INTEGRATION_INSTANCE", 'UNKNOWN_ENUM_VALUE'. - Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. - - - :return: The operation_type of this WorkRequest. - :rtype: str - """ - return self._operation_type - - @operation_type.setter - def operation_type(self, operation_type): - """ - Sets the operation_type of this WorkRequest. - Type of the work request. - - - :param operation_type: The operation_type of this WorkRequest. - :type: str - """ - allowed_values = ["CREATE_INTEGRATION_INSTANCE", "UPDATE_INTEGRATION_INSTANCE", "DELETE_INTEGRATION_INSTANCE"] - if not value_allowed_none_or_none_sentinel(operation_type, allowed_values): - operation_type = 'UNKNOWN_ENUM_VALUE' - self._operation_type = operation_type - - @property - def status(self): - """ - **[Required]** Gets the status of this WorkRequest. - Status of current work request. - - Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED", 'UNKNOWN_ENUM_VALUE'. - Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. - - - :return: The status of this WorkRequest. - :rtype: str - """ - return self._status - - @status.setter - def status(self, status): - """ - Sets the status of this WorkRequest. - Status of current work request. - - - :param status: The status of this WorkRequest. - :type: str - """ - allowed_values = ["ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED"] - if not value_allowed_none_or_none_sentinel(status, allowed_values): - status = 'UNKNOWN_ENUM_VALUE' - self._status = status - - @property - def id(self): - """ - **[Required]** Gets the id of this WorkRequest. - The id of the work request. - - - :return: The id of this WorkRequest. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this WorkRequest. - The id of the work request. - - - :param id: The id of this WorkRequest. - :type: str - """ - self._id = id - - @property - def compartment_id(self): - """ - **[Required]** Gets the compartment_id of this WorkRequest. - The ocid of the compartment that contains the work request. Work - requests should be scoped to the same compartment as the resource the - work request affects. If the work request affects multiple resources, - and those resources are not in the same compartment, it is up to the - service team to pick the primary resource whose compartment should be - used. - - - :return: The compartment_id of this WorkRequest. - :rtype: str - """ - return self._compartment_id - - @compartment_id.setter - def compartment_id(self, compartment_id): - """ - Sets the compartment_id of this WorkRequest. - The ocid of the compartment that contains the work request. Work - requests should be scoped to the same compartment as the resource the - work request affects. If the work request affects multiple resources, - and those resources are not in the same compartment, it is up to the - service team to pick the primary resource whose compartment should be - used. - - - :param compartment_id: The compartment_id of this WorkRequest. - :type: str - """ - self._compartment_id = compartment_id - - @property - def resources(self): - """ - **[Required]** Gets the resources of this WorkRequest. - The resources affected by this work request. - - - :return: The resources of this WorkRequest. - :rtype: list[WorkRequestResource] - """ - return self._resources - - @resources.setter - def resources(self, resources): - """ - Sets the resources of this WorkRequest. - The resources affected by this work request. - - - :param resources: The resources of this WorkRequest. - :type: list[WorkRequestResource] - """ - self._resources = resources - - @property - def percent_complete(self): - """ - **[Required]** Gets the percent_complete of this WorkRequest. - Percentage of the request completed. - - - :return: The percent_complete of this WorkRequest. - :rtype: float - """ - return self._percent_complete - - @percent_complete.setter - def percent_complete(self, percent_complete): - """ - Sets the percent_complete of this WorkRequest. - Percentage of the request completed. - - - :param percent_complete: The percent_complete of this WorkRequest. - :type: float - """ - self._percent_complete = percent_complete - - @property - def time_accepted(self): - """ - **[Required]** Gets the time_accepted of this WorkRequest. - The date and time the request was created, as described in - `RFC 3339`__, section 14.29. - - __ https://tools.ietf.org/rfc/rfc3339 - - - :return: The time_accepted of this WorkRequest. - :rtype: datetime - """ - return self._time_accepted - - @time_accepted.setter - def time_accepted(self, time_accepted): - """ - Sets the time_accepted of this WorkRequest. - The date and time the request was created, as described in - `RFC 3339`__, section 14.29. - - __ https://tools.ietf.org/rfc/rfc3339 - - - :param time_accepted: The time_accepted of this WorkRequest. - :type: datetime - """ - self._time_accepted = time_accepted - - @property - def time_started(self): - """ - Gets the time_started of this WorkRequest. - The date and time the request was started, as described in - `RFC 3339`__, - section 14.29. - - __ https://tools.ietf.org/rfc/rfc3339 - - - :return: The time_started of this WorkRequest. - :rtype: datetime - """ - return self._time_started - - @time_started.setter - def time_started(self, time_started): - """ - Sets the time_started of this WorkRequest. - The date and time the request was started, as described in - `RFC 3339`__, - section 14.29. - - __ https://tools.ietf.org/rfc/rfc3339 - - - :param time_started: The time_started of this WorkRequest. - :type: datetime - """ - self._time_started = time_started - - @property - def time_finished(self): - """ - Gets the time_finished of this WorkRequest. - The date and time the object was finished, as described in - `RFC 3339`__. - - __ https://tools.ietf.org/rfc/rfc3339 - - - :return: The time_finished of this WorkRequest. - :rtype: datetime - """ - return self._time_finished - - @time_finished.setter - def time_finished(self, time_finished): - """ - Sets the time_finished of this WorkRequest. - The date and time the object was finished, as described in - `RFC 3339`__. - - __ https://tools.ietf.org/rfc/rfc3339 - - - :param time_finished: The time_finished of this WorkRequest. - :type: datetime - """ - self._time_finished = time_finished - - def __repr__(self): - return formatted_flat_dict(self) - - def __eq__(self, other): - if other is None: - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - return not self == other diff --git a/src/oci/integration/models/work_request_error.py b/src/oci/integration/models/work_request_error.py deleted file mode 100644 index 3efa09ab87..0000000000 --- a/src/oci/integration/models/work_request_error.py +++ /dev/null @@ -1,131 +0,0 @@ -# coding: utf-8 -# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. - - -from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 -from oci.decorators import init_model_state_from_kwargs - - -@init_model_state_from_kwargs -class WorkRequestError(object): - """ - Errors related to a specific work request. - """ - - def __init__(self, **kwargs): - """ - Initializes a new WorkRequestError object with values from keyword arguments. - The following keyword arguments are supported (corresponding to the getters/setters of this class): - - :param code: - The value to assign to the code property of this WorkRequestError. - :type code: str - - :param message: - The value to assign to the message property of this WorkRequestError. - :type message: str - - :param timestamp: - The value to assign to the timestamp property of this WorkRequestError. - :type timestamp: datetime - - """ - self.swagger_types = { - 'code': 'str', - 'message': 'str', - 'timestamp': 'datetime' - } - - self.attribute_map = { - 'code': 'code', - 'message': 'message', - 'timestamp': 'timestamp' - } - - self._code = None - self._message = None - self._timestamp = None - - @property - def code(self): - """ - **[Required]** Gets the code of this WorkRequestError. - A short error code that defines the error, meant for programmatic parsing - - - :return: The code of this WorkRequestError. - :rtype: str - """ - return self._code - - @code.setter - def code(self, code): - """ - Sets the code of this WorkRequestError. - A short error code that defines the error, meant for programmatic parsing - - - :param code: The code of this WorkRequestError. - :type: str - """ - self._code = code - - @property - def message(self): - """ - **[Required]** Gets the message of this WorkRequestError. - A human-readable error string. - - - :return: The message of this WorkRequestError. - :rtype: str - """ - return self._message - - @message.setter - def message(self, message): - """ - Sets the message of this WorkRequestError. - A human-readable error string. - - - :param message: The message of this WorkRequestError. - :type: str - """ - self._message = message - - @property - def timestamp(self): - """ - **[Required]** Gets the timestamp of this WorkRequestError. - The date and time the error occurred. - - - :return: The timestamp of this WorkRequestError. - :rtype: datetime - """ - return self._timestamp - - @timestamp.setter - def timestamp(self, timestamp): - """ - Sets the timestamp of this WorkRequestError. - The date and time the error occurred. - - - :param timestamp: The timestamp of this WorkRequestError. - :type: datetime - """ - self._timestamp = timestamp - - def __repr__(self): - return formatted_flat_dict(self) - - def __eq__(self, other): - if other is None: - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - return not self == other diff --git a/src/oci/integration/models/work_request_log_entry.py b/src/oci/integration/models/work_request_log_entry.py deleted file mode 100644 index 855ce2f3db..0000000000 --- a/src/oci/integration/models/work_request_log_entry.py +++ /dev/null @@ -1,100 +0,0 @@ -# coding: utf-8 -# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. - - -from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 -from oci.decorators import init_model_state_from_kwargs - - -@init_model_state_from_kwargs -class WorkRequestLogEntry(object): - """ - Log entries related to a specific work request. - """ - - def __init__(self, **kwargs): - """ - Initializes a new WorkRequestLogEntry object with values from keyword arguments. - The following keyword arguments are supported (corresponding to the getters/setters of this class): - - :param message: - The value to assign to the message property of this WorkRequestLogEntry. - :type message: str - - :param timestamp: - The value to assign to the timestamp property of this WorkRequestLogEntry. - :type timestamp: datetime - - """ - self.swagger_types = { - 'message': 'str', - 'timestamp': 'datetime' - } - - self.attribute_map = { - 'message': 'message', - 'timestamp': 'timestamp' - } - - self._message = None - self._timestamp = None - - @property - def message(self): - """ - **[Required]** Gets the message of this WorkRequestLogEntry. - The description of an action that occurred. - - - :return: The message of this WorkRequestLogEntry. - :rtype: str - """ - return self._message - - @message.setter - def message(self, message): - """ - Sets the message of this WorkRequestLogEntry. - The description of an action that occurred. - - - :param message: The message of this WorkRequestLogEntry. - :type: str - """ - self._message = message - - @property - def timestamp(self): - """ - **[Required]** Gets the timestamp of this WorkRequestLogEntry. - The date and time the log entry occurred. - - - :return: The timestamp of this WorkRequestLogEntry. - :rtype: datetime - """ - return self._timestamp - - @timestamp.setter - def timestamp(self, timestamp): - """ - Sets the timestamp of this WorkRequestLogEntry. - The date and time the log entry occurred. - - - :param timestamp: The timestamp of this WorkRequestLogEntry. - :type: datetime - """ - self._timestamp = timestamp - - def __repr__(self): - return formatted_flat_dict(self) - - def __eq__(self, other): - if other is None: - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - return not self == other diff --git a/src/oci/integration/models/work_request_resource.py b/src/oci/integration/models/work_request_resource.py deleted file mode 100644 index 74de1c35ab..0000000000 --- a/src/oci/integration/models/work_request_resource.py +++ /dev/null @@ -1,194 +0,0 @@ -# coding: utf-8 -# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. - - -from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 -from oci.decorators import init_model_state_from_kwargs - - -@init_model_state_from_kwargs -class WorkRequestResource(object): - """ - A resource created or operated on by a work request. - """ - - #: A constant which can be used with the action_type property of a WorkRequestResource. - #: This constant has a value of "CREATED" - ACTION_TYPE_CREATED = "CREATED" - - #: A constant which can be used with the action_type property of a WorkRequestResource. - #: This constant has a value of "UPDATED" - ACTION_TYPE_UPDATED = "UPDATED" - - #: A constant which can be used with the action_type property of a WorkRequestResource. - #: This constant has a value of "DELETED" - ACTION_TYPE_DELETED = "DELETED" - - #: A constant which can be used with the action_type property of a WorkRequestResource. - #: This constant has a value of "IN_PROGRESS" - ACTION_TYPE_IN_PROGRESS = "IN_PROGRESS" - - def __init__(self, **kwargs): - """ - Initializes a new WorkRequestResource object with values from keyword arguments. - The following keyword arguments are supported (corresponding to the getters/setters of this class): - - :param entity_type: - The value to assign to the entity_type property of this WorkRequestResource. - :type entity_type: str - - :param action_type: - The value to assign to the action_type property of this WorkRequestResource. - Allowed values for this property are: "CREATED", "UPDATED", "DELETED", "IN_PROGRESS", 'UNKNOWN_ENUM_VALUE'. - Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. - :type action_type: str - - :param identifier: - The value to assign to the identifier property of this WorkRequestResource. - :type identifier: str - - :param entity_uri: - The value to assign to the entity_uri property of this WorkRequestResource. - :type entity_uri: str - - """ - self.swagger_types = { - 'entity_type': 'str', - 'action_type': 'str', - 'identifier': 'str', - 'entity_uri': 'str' - } - - self.attribute_map = { - 'entity_type': 'entityType', - 'action_type': 'actionType', - 'identifier': 'identifier', - 'entity_uri': 'entityUri' - } - - self._entity_type = None - self._action_type = None - self._identifier = None - self._entity_uri = None - - @property - def entity_type(self): - """ - **[Required]** Gets the entity_type of this WorkRequestResource. - The resource type the work request is affects. - - - :return: The entity_type of this WorkRequestResource. - :rtype: str - """ - return self._entity_type - - @entity_type.setter - def entity_type(self, entity_type): - """ - Sets the entity_type of this WorkRequestResource. - The resource type the work request is affects. - - - :param entity_type: The entity_type of this WorkRequestResource. - :type: str - """ - self._entity_type = entity_type - - @property - def action_type(self): - """ - **[Required]** Gets the action_type of this WorkRequestResource. - The way in which this resource is affected by the work tracked in the - work request. A resource being created, updated, or deleted will - remain in the IN_PROGRESS state until work is complete for that - resource at which point it will transition to CREATED, UPDATED, - or DELETED, respectively. - - Allowed values for this property are: "CREATED", "UPDATED", "DELETED", "IN_PROGRESS", 'UNKNOWN_ENUM_VALUE'. - Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. - - - :return: The action_type of this WorkRequestResource. - :rtype: str - """ - return self._action_type - - @action_type.setter - def action_type(self, action_type): - """ - Sets the action_type of this WorkRequestResource. - The way in which this resource is affected by the work tracked in the - work request. A resource being created, updated, or deleted will - remain in the IN_PROGRESS state until work is complete for that - resource at which point it will transition to CREATED, UPDATED, - or DELETED, respectively. - - - :param action_type: The action_type of this WorkRequestResource. - :type: str - """ - allowed_values = ["CREATED", "UPDATED", "DELETED", "IN_PROGRESS"] - if not value_allowed_none_or_none_sentinel(action_type, allowed_values): - action_type = 'UNKNOWN_ENUM_VALUE' - self._action_type = action_type - - @property - def identifier(self): - """ - **[Required]** Gets the identifier of this WorkRequestResource. - The identifier of the resource the work request affects. - - - :return: The identifier of this WorkRequestResource. - :rtype: str - """ - return self._identifier - - @identifier.setter - def identifier(self, identifier): - """ - Sets the identifier of this WorkRequestResource. - The identifier of the resource the work request affects. - - - :param identifier: The identifier of this WorkRequestResource. - :type: str - """ - self._identifier = identifier - - @property - def entity_uri(self): - """ - Gets the entity_uri of this WorkRequestResource. - The URI path that the user can do a GET on to access the resource metadata. - - - :return: The entity_uri of this WorkRequestResource. - :rtype: str - """ - return self._entity_uri - - @entity_uri.setter - def entity_uri(self, entity_uri): - """ - Sets the entity_uri of this WorkRequestResource. - The URI path that the user can do a GET on to access the resource metadata. - - - :param entity_uri: The entity_uri of this WorkRequestResource. - :type: str - """ - self._entity_uri = entity_uri - - def __repr__(self): - return formatted_flat_dict(self) - - def __eq__(self, other): - if other is None: - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - return not self == other diff --git a/src/oci/integration/models/work_request_summary.py b/src/oci/integration/models/work_request_summary.py deleted file mode 100644 index adf2d5ccec..0000000000 --- a/src/oci/integration/models/work_request_summary.py +++ /dev/null @@ -1,399 +0,0 @@ -# coding: utf-8 -# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. - - -from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 -from oci.decorators import init_model_state_from_kwargs - - -@init_model_state_from_kwargs -class WorkRequestSummary(object): - """ - A description of work request status. - """ - - #: A constant which can be used with the operation_type property of a WorkRequestSummary. - #: This constant has a value of "CREATE_INTEGRATION_INSTANCE" - OPERATION_TYPE_CREATE_INTEGRATION_INSTANCE = "CREATE_INTEGRATION_INSTANCE" - - #: A constant which can be used with the operation_type property of a WorkRequestSummary. - #: This constant has a value of "UPDATE_INTEGRATION_INSTANCE" - OPERATION_TYPE_UPDATE_INTEGRATION_INSTANCE = "UPDATE_INTEGRATION_INSTANCE" - - #: A constant which can be used with the operation_type property of a WorkRequestSummary. - #: This constant has a value of "DELETE_INTEGRATION_INSTANCE" - OPERATION_TYPE_DELETE_INTEGRATION_INSTANCE = "DELETE_INTEGRATION_INSTANCE" - - #: A constant which can be used with the status property of a WorkRequestSummary. - #: This constant has a value of "ACCEPTED" - STATUS_ACCEPTED = "ACCEPTED" - - #: A constant which can be used with the status property of a WorkRequestSummary. - #: This constant has a value of "IN_PROGRESS" - STATUS_IN_PROGRESS = "IN_PROGRESS" - - #: A constant which can be used with the status property of a WorkRequestSummary. - #: This constant has a value of "FAILED" - STATUS_FAILED = "FAILED" - - #: A constant which can be used with the status property of a WorkRequestSummary. - #: This constant has a value of "SUCCEEDED" - STATUS_SUCCEEDED = "SUCCEEDED" - - #: A constant which can be used with the status property of a WorkRequestSummary. - #: This constant has a value of "CANCELING" - STATUS_CANCELING = "CANCELING" - - #: A constant which can be used with the status property of a WorkRequestSummary. - #: This constant has a value of "CANCELED" - STATUS_CANCELED = "CANCELED" - - def __init__(self, **kwargs): - """ - Initializes a new WorkRequestSummary object with values from keyword arguments. - The following keyword arguments are supported (corresponding to the getters/setters of this class): - - :param operation_type: - The value to assign to the operation_type property of this WorkRequestSummary. - Allowed values for this property are: "CREATE_INTEGRATION_INSTANCE", "UPDATE_INTEGRATION_INSTANCE", "DELETE_INTEGRATION_INSTANCE", 'UNKNOWN_ENUM_VALUE'. - Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. - :type operation_type: str - - :param status: - The value to assign to the status property of this WorkRequestSummary. - Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED", 'UNKNOWN_ENUM_VALUE'. - Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. - :type status: str - - :param id: - The value to assign to the id property of this WorkRequestSummary. - :type id: str - - :param compartment_id: - The value to assign to the compartment_id property of this WorkRequestSummary. - :type compartment_id: str - - :param resources: - The value to assign to the resources property of this WorkRequestSummary. - :type resources: list[WorkRequestResource] - - :param percent_complete: - The value to assign to the percent_complete property of this WorkRequestSummary. - :type percent_complete: float - - :param time_accepted: - The value to assign to the time_accepted property of this WorkRequestSummary. - :type time_accepted: datetime - - :param time_started: - The value to assign to the time_started property of this WorkRequestSummary. - :type time_started: datetime - - :param time_finished: - The value to assign to the time_finished property of this WorkRequestSummary. - :type time_finished: datetime - - """ - self.swagger_types = { - 'operation_type': 'str', - 'status': 'str', - 'id': 'str', - 'compartment_id': 'str', - 'resources': 'list[WorkRequestResource]', - 'percent_complete': 'float', - 'time_accepted': 'datetime', - 'time_started': 'datetime', - 'time_finished': 'datetime' - } - - self.attribute_map = { - 'operation_type': 'operationType', - 'status': 'status', - 'id': 'id', - 'compartment_id': 'compartmentId', - 'resources': 'resources', - 'percent_complete': 'percentComplete', - 'time_accepted': 'timeAccepted', - 'time_started': 'timeStarted', - 'time_finished': 'timeFinished' - } - - self._operation_type = None - self._status = None - self._id = None - self._compartment_id = None - self._resources = None - self._percent_complete = None - self._time_accepted = None - self._time_started = None - self._time_finished = None - - @property - def operation_type(self): - """ - **[Required]** Gets the operation_type of this WorkRequestSummary. - Type of the work request. - - Allowed values for this property are: "CREATE_INTEGRATION_INSTANCE", "UPDATE_INTEGRATION_INSTANCE", "DELETE_INTEGRATION_INSTANCE", 'UNKNOWN_ENUM_VALUE'. - Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. - - - :return: The operation_type of this WorkRequestSummary. - :rtype: str - """ - return self._operation_type - - @operation_type.setter - def operation_type(self, operation_type): - """ - Sets the operation_type of this WorkRequestSummary. - Type of the work request. - - - :param operation_type: The operation_type of this WorkRequestSummary. - :type: str - """ - allowed_values = ["CREATE_INTEGRATION_INSTANCE", "UPDATE_INTEGRATION_INSTANCE", "DELETE_INTEGRATION_INSTANCE"] - if not value_allowed_none_or_none_sentinel(operation_type, allowed_values): - operation_type = 'UNKNOWN_ENUM_VALUE' - self._operation_type = operation_type - - @property - def status(self): - """ - **[Required]** Gets the status of this WorkRequestSummary. - Status of current work request. - - Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED", 'UNKNOWN_ENUM_VALUE'. - Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. - - - :return: The status of this WorkRequestSummary. - :rtype: str - """ - return self._status - - @status.setter - def status(self, status): - """ - Sets the status of this WorkRequestSummary. - Status of current work request. - - - :param status: The status of this WorkRequestSummary. - :type: str - """ - allowed_values = ["ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED"] - if not value_allowed_none_or_none_sentinel(status, allowed_values): - status = 'UNKNOWN_ENUM_VALUE' - self._status = status - - @property - def id(self): - """ - **[Required]** Gets the id of this WorkRequestSummary. - The id of the work request. - - - :return: The id of this WorkRequestSummary. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this WorkRequestSummary. - The id of the work request. - - - :param id: The id of this WorkRequestSummary. - :type: str - """ - self._id = id - - @property - def compartment_id(self): - """ - **[Required]** Gets the compartment_id of this WorkRequestSummary. - The ocid of the compartment that contains the work request. Work - requests should be scoped to the same compartment as the resource the - work request affects. If the work request affects multiple resources, - and those resources are not in the same compartment, it is up to the - service team to pick the primary resource whose compartment should be - used. - - - :return: The compartment_id of this WorkRequestSummary. - :rtype: str - """ - return self._compartment_id - - @compartment_id.setter - def compartment_id(self, compartment_id): - """ - Sets the compartment_id of this WorkRequestSummary. - The ocid of the compartment that contains the work request. Work - requests should be scoped to the same compartment as the resource the - work request affects. If the work request affects multiple resources, - and those resources are not in the same compartment, it is up to the - service team to pick the primary resource whose compartment should be - used. - - - :param compartment_id: The compartment_id of this WorkRequestSummary. - :type: str - """ - self._compartment_id = compartment_id - - @property - def resources(self): - """ - **[Required]** Gets the resources of this WorkRequestSummary. - The resources affected by this work request. - - - :return: The resources of this WorkRequestSummary. - :rtype: list[WorkRequestResource] - """ - return self._resources - - @resources.setter - def resources(self, resources): - """ - Sets the resources of this WorkRequestSummary. - The resources affected by this work request. - - - :param resources: The resources of this WorkRequestSummary. - :type: list[WorkRequestResource] - """ - self._resources = resources - - @property - def percent_complete(self): - """ - **[Required]** Gets the percent_complete of this WorkRequestSummary. - Percentage of the request completed. - - - :return: The percent_complete of this WorkRequestSummary. - :rtype: float - """ - return self._percent_complete - - @percent_complete.setter - def percent_complete(self, percent_complete): - """ - Sets the percent_complete of this WorkRequestSummary. - Percentage of the request completed. - - - :param percent_complete: The percent_complete of this WorkRequestSummary. - :type: float - """ - self._percent_complete = percent_complete - - @property - def time_accepted(self): - """ - **[Required]** Gets the time_accepted of this WorkRequestSummary. - The date and time the request was created, as described in - `RFC 3339`__, section 14.29. - - __ https://tools.ietf.org/rfc/rfc3339 - - - :return: The time_accepted of this WorkRequestSummary. - :rtype: datetime - """ - return self._time_accepted - - @time_accepted.setter - def time_accepted(self, time_accepted): - """ - Sets the time_accepted of this WorkRequestSummary. - The date and time the request was created, as described in - `RFC 3339`__, section 14.29. - - __ https://tools.ietf.org/rfc/rfc3339 - - - :param time_accepted: The time_accepted of this WorkRequestSummary. - :type: datetime - """ - self._time_accepted = time_accepted - - @property - def time_started(self): - """ - Gets the time_started of this WorkRequestSummary. - The date and time the request was started, as described in - `RFC 3339`__, - section 14.29. - - __ https://tools.ietf.org/rfc/rfc3339 - - - :return: The time_started of this WorkRequestSummary. - :rtype: datetime - """ - return self._time_started - - @time_started.setter - def time_started(self, time_started): - """ - Sets the time_started of this WorkRequestSummary. - The date and time the request was started, as described in - `RFC 3339`__, - section 14.29. - - __ https://tools.ietf.org/rfc/rfc3339 - - - :param time_started: The time_started of this WorkRequestSummary. - :type: datetime - """ - self._time_started = time_started - - @property - def time_finished(self): - """ - Gets the time_finished of this WorkRequestSummary. - The date and time the object was finished, as described in - `RFC 3339`__. - - __ https://tools.ietf.org/rfc/rfc3339 - - - :return: The time_finished of this WorkRequestSummary. - :rtype: datetime - """ - return self._time_finished - - @time_finished.setter - def time_finished(self, time_finished): - """ - Sets the time_finished of this WorkRequestSummary. - The date and time the object was finished, as described in - `RFC 3339`__. - - __ https://tools.ietf.org/rfc/rfc3339 - - - :param time_finished: The time_finished of this WorkRequestSummary. - :type: datetime - """ - self._time_finished = time_finished - - def __repr__(self): - return formatted_flat_dict(self) - - def __eq__(self, other): - if other is None: - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - return not self == other diff --git a/src/oci/key_management/kms_crypto_client.py b/src/oci/key_management/kms_crypto_client.py index be942c6193..52bb311ec3 100644 --- a/src/oci/key_management/kms_crypto_client.py +++ b/src/oci/key_management/kms_crypto_client.py @@ -72,6 +72,7 @@ def __init__(self, config, service_endpoint, **kwargs): 'service_endpoint': service_endpoint, 'timeout': kwargs.get('timeout'), 'base_path': '/', + 'service_endpoint_template': 'https://kms.{region}.{secondLevelDomain}', 'skip_deserialization': kwargs.get('skip_deserialization', False) } self.base_client = BaseClient("kms_crypto", config, signer, key_management_type_mapping, **base_client_init_kwargs) @@ -80,7 +81,9 @@ def __init__(self, config, service_endpoint, **kwargs): def decrypt(self, decrypt_data_details, **kwargs): """ Decrypt - Decrypts data using the given DecryptDataDetails resource. + Decrypts data using the given `DecryptDataDetails`__ resource. + + __ https://docs.cloud.oracle.com/api/#/en/key/release/datatypes/DecryptDataDetails :param DecryptDataDetails decrypt_data_details: (required) @@ -145,9 +148,10 @@ def decrypt(self, decrypt_data_details, **kwargs): def encrypt(self, encrypt_data_details, **kwargs): """ Encrypt - Encrypts data using the given EncryptDataDetails resource. - Plaintext included in the example request is a base64-encoded value - of a UTF-8 string. + Encrypts data using the given `EncryptDataDetails`__ resource. + Plaintext included in the example request is a base64-encoded value of a UTF-8 string. + + __ https://docs.cloud.oracle.com/api/#/en/key/release/datatypes/EncryptDataDetails :param EncryptDataDetails encrypt_data_details: (required) diff --git a/src/oci/key_management/kms_management_client.py b/src/oci/key_management/kms_management_client.py index cd1efcc53e..92dfaeb416 100644 --- a/src/oci/key_management/kms_management_client.py +++ b/src/oci/key_management/kms_management_client.py @@ -72,6 +72,7 @@ def __init__(self, config, service_endpoint, **kwargs): 'service_endpoint': service_endpoint, 'timeout': kwargs.get('timeout'), 'base_path': '/', + 'service_endpoint_template': 'https://kms.{region}.{secondLevelDomain}', 'skip_deserialization': kwargs.get('skip_deserialization', False) } self.base_client = BaseClient("kms_management", config, signer, key_management_type_mapping, **base_client_init_kwargs) @@ -81,8 +82,13 @@ def cancel_key_deletion(self, key_id, **kwargs): """ Cancels the scheduled deletion of a key. Cancels the scheduled deletion of the specified key. Canceling - a scheduled deletion restores the key to the respective - states they were in before the deletion was scheduled. + a scheduled deletion restores the key's lifecycle state to what + it was before its scheduled deletion. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning write operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + write operations exceeds 10 requests per second for a given tenancy. :param str key_id: (required) @@ -175,10 +181,127 @@ def cancel_key_deletion(self, key_id, **kwargs): header_params=header_params, response_type="Key") + def cancel_key_version_deletion(self, key_id, key_version_id, **kwargs): + """ + Cancels the scheduled deletion of a key version. + Cancels the scheduled deletion of the specified key version. Canceling + a scheduled deletion restores the key version to its lifecycle state from + before its scheduled deletion. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning write operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + write operations exceeds 10 requests per second for a given tenancy. + + + :param str key_id: (required) + The OCID of the key. + + :param str key_version_id: (required) + The OCID of the key version. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call for a + resource, set the `if-match` parameter to the value of the etag from a + previous GET or POST response for that resource. The resource will be + updated or deleted only if the etag you provide matches the resource's + current etag value. + + :param str opc_request_id: (optional) + Unique identifier for the request. If provided, the returned request ID + will include this value. Otherwise, a random request ID will be + generated by the service. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case + of a timeout or server error without risk of executing that same action + again. Retry tokens expire after 24 hours, but can be invalidated + before then due to conflicting operations (e.g., if a resource has been + deleted and purged from the system, then a retry of the original + creation request may be rejected). + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.key_management.models.KeyVersion` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/20180608/keys/{keyId}/keyVersions/{keyVersionId}/actions/cancelDeletion" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "if_match", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "cancel_key_version_deletion got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "keyId": key_id, + "keyVersionId": key_version_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="KeyVersion") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="KeyVersion") + def change_key_compartment(self, key_id, change_key_compartment_details, **kwargs): """ - Moves a key into a different compartment. When provided, If-Match is checked against ETag values of the key. - Moves a key into a different compartment. When provided, If-Match is checked against ETag values of the key. + Moves a key into a different compartment. + Moves a key into a different compartment within the same tenancy. For information about + moving resources between compartments, see `Moving Resources to a Different Compartment`__. + + When provided, if-match is checked against the ETag values of the key. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning write operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + write operations exceeds 10 requests per second for a given tenancy. + + __ https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes :param str key_id: (required) @@ -276,7 +399,12 @@ def change_key_compartment(self, key_id, change_key_compartment_details, **kwarg def create_key(self, create_key_details, **kwargs): """ Creates a new key. - Creates a new key. + Creates a new master encryption key. + + As a management operation, this call is subject to a Key Management limit that applies to the total + number of requests across all management write operations. Key Management might throttle this call + to reject an otherwise valid request when the total rate of management write operations exceeds 10 + requests per second for a given tenancy. :param CreateKeyDetails create_key_details: (required) @@ -352,9 +480,16 @@ def create_key(self, create_key_details, **kwargs): def create_key_version(self, key_id, **kwargs): """ - Creates a new KeyVersion resource and rotates the key to use it for encryption. - Generates new cryptographic material for a key. The key must be in an `ENABLED` state to be - rotated. + Creates a new key version resource and rotates the key to use it for encryption. + Generates a new `KeyVersion`__ resource that provides new cryptographic + material for a master encryption key. The key must be in an ENABLED state to be rotated. + + As a management operation, this call is subject to a Key Management limit that applies to the total number + of requests across all management write operations. Key Management might throttle this call to reject an + otherwise valid request when the total rate of management write operations exceeds 10 requests per second + for a given tenancy. + + __ https://docs.cloud.oracle.com/api/#/en/key/release/KeyVersion/ :param str key_id: (required) @@ -441,8 +576,13 @@ def create_key_version(self, key_id, **kwargs): def disable_key(self, key_id, **kwargs): """ Disables a key so it cannot be used for cryptographic operations. - Disables a key to make it unavailable for encryption - or decryption. + Disables a master encryption key so it can no longer be used for encryption, decryption, or + generating new data encryption keys. + + As a management operation, this call is subject to a Key Management limit that applies to the total number + of requests across all management write operations. Key Management might throttle this call to reject an + otherwise valid request when the total rate of management write operations exceeds 10 requests per second + for a given tenancy. :param str key_id: (required) @@ -538,8 +678,13 @@ def disable_key(self, key_id, **kwargs): def enable_key(self, key_id, **kwargs): """ Enables a key so it can be used for cryptographic operations. - Enables a key to make it available for encryption or - decryption. + Enables a master encryption key so it can be used for encryption, decryption, or + generating new data encryption keys. + + As a management operation, this call is subject to a Key Management limit that applies to the total number + of requests across all management write operations. Key Management might throttle this call to reject an + otherwise valid request when the total rate of management write operations exceeds 10 requests per second + for a given tenancy. :param str key_id: (required) @@ -635,7 +780,12 @@ def enable_key(self, key_id, **kwargs): def get_key(self, key_id, **kwargs): """ Gets details about a key. - Gets information about the specified key. + Gets information about the specified master encryption key. + + As a management operation, this call is subject to a Key Management limit that applies to the total number + of requests across all management read operations. Key Management might throttle this call to reject an + otherwise valid request when the total rate of management read operations exceeds 10 requests per second for + a given tenancy. :param str key_id: (required) @@ -712,6 +862,11 @@ def get_key_version(self, key_id, key_version_id, **kwargs): Gets details about a key version. Gets information about the specified key version. + As a management operation, this call is subject to a Key Management limit that applies to the total number + of requests across all management read operations. Key Management might throttle this call to reject an + otherwise valid request when the total rate of management read operations exceeds 10 requests per second + for a given tenancy. + :param str key_id: (required) The OCID of the key. @@ -786,10 +941,247 @@ def get_key_version(self, key_id, key_version_id, **kwargs): header_params=header_params, response_type="KeyVersion") + def get_wrapping_key(self, **kwargs): + """ + Gets details about the RSA wrapping key. The RSA wrapping key is used to wrap/unwrap the AES key to be imported to KMS. There will be only one RSA wrapping key per vault. + Returns the RSA wrapping key associated with the vault in the endpoint. + + + :param str opc_request_id: (optional) + Unique identifier for the request. If provided, the returned request ID + will include this value. Otherwise, a random request ID will be + generated by the service. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.key_management.models.WrappingKey` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/20180608/wrappingKeys" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_wrapping_key got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + header_params=header_params, + response_type="WrappingKey") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + response_type="WrappingKey") + + def import_key(self, import_key_details, **kwargs): + """ + Imports the given wrapped/encrypted AES key + Imports the given wrapped/encrypted AES key. + + + :param ImportKeyDetails import_key_details: (required) + ImportKeyDetails + + :param str opc_request_id: (optional) + Unique identifier for the request. If provided, the returned request ID + will include this value. Otherwise, a random request ID will be + generated by the service. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case + of a timeout or server error without risk of executing that same action + again. Retry tokens expire after 24 hours, but can be invalidated + before then due to conflicting operations (e.g., if a resource has been + deleted and purged from the system, then a retry of the original + creation request may be rejected). + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.key_management.models.Key` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/20180608/keys/import" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "import_key got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + header_params=header_params, + body=import_key_details, + response_type="Key") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=import_key_details, + response_type="Key") + + def import_key_version(self, key_id, import_key_version_details, **kwargs): + """ + Imports the given key as a new KeyVersion for the specified key and rotates the key to use it for encryption. + Imports the given key version. + + + :param str key_id: (required) + The OCID of the key. + + :param ImportKeyVersionDetails import_key_version_details: (required) + ImportKeyVersionDetails + + :param str opc_request_id: (optional) + Unique identifier for the request. If provided, the returned request ID + will include this value. Otherwise, a random request ID will be + generated by the service. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case + of a timeout or server error without risk of executing that same action + again. Retry tokens expire after 24 hours, but can be invalidated + before then due to conflicting operations (e.g., if a resource has been + deleted and purged from the system, then a retry of the original + creation request may be rejected). + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.key_management.models.KeyVersion` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/20180608/keys/{keyId}/keyVersions/import" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "import_key_version got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "keyId": key_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=import_key_version_details, + response_type="KeyVersion") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=import_key_version_details, + response_type="KeyVersion") + def list_key_versions(self, key_id, **kwargs): """ - Lists the KeyVersion resources for a key. - Lists all key versions for the specified key. + Lists all key versions for a key. + Lists all `KeyVersion`__ resources for the specified + master encryption key. + + As a management operation, this call is subject to a Key Management limit that applies to the total number + of requests across all management read operations. Key Management might throttle this call to reject an + otherwise valid request when the total rate of management read operations exceeds 10 requests per second + for a given tenancy. + + __ https://docs.cloud.oracle.com/api/#/en/key/release/KeyVersion/ :param str key_id: (required) @@ -809,7 +1201,7 @@ def list_key_versions(self, key_id, **kwargs): :param str sort_by: (optional) The field to sort by. You can specify only one sort order. The default - order for TIMECREATED is descending. The default order for DISPLAYNAME + order for `TIMECREATED` is descending. The default order for `DISPLAYNAME` is ascending. Allowed values are: "TIMECREATED", "DISPLAYNAME" @@ -911,7 +1303,12 @@ def list_key_versions(self, key_id, **kwargs): def list_keys(self, compartment_id, **kwargs): """ Lists keys in the specified vault and compartment. - Lists the keys in the specified vault and compartment. + Lists the master encryption keys in the specified vault and compartment. + + As a management operation, this call is subject to a Key Management limit that applies to the total number + of requests across all management read operations. Key Management might throttle this call to reject an + otherwise valid request when the total rate of management read operations exceeds 10 requests per second + for a given tenancy. :param str compartment_id: (required) @@ -931,7 +1328,7 @@ def list_keys(self, compartment_id, **kwargs): :param str sort_by: (optional) The field to sort by. You can specify only one sort order. The default - order for TIMECREATED is descending. The default order for DISPLAYNAME + order for `TIMECREATED` is descending. The default order for `DISPLAYNAME` is ascending. Allowed values are: "TIMECREATED", "DISPLAYNAME" @@ -1022,8 +1419,13 @@ def list_keys(self, compartment_id, **kwargs): def schedule_key_deletion(self, key_id, schedule_key_deletion_details, **kwargs): """ Schedules the deletion of a key. - Schedules the deletion of the specified key. This sets the state of the key - to `PENDING_DELETION` and then deletes it after the retention period ends. + Schedules the deletion of the specified key. This sets the lifecycle state of the key + to `PENDING_DELETION` and then deletes it after the specified retention period ends. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning write operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + write operations exceeds 10 requests per second for a given tenancy. :param str key_id: (required) @@ -1121,12 +1523,128 @@ def schedule_key_deletion(self, key_id, schedule_key_deletion_details, **kwargs) body=schedule_key_deletion_details, response_type="Key") + def schedule_key_version_deletion(self, key_id, key_version_id, schedule_key_version_deletion_details, **kwargs): + """ + Schedules the deletion of a key version. + Schedules the deletion of the specified key version. This sets the lifecycle state of the key version + to `PENDING_DELETION` and then deletes it after the specified retention period ends. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning write operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + write operations exceeds 10 requests per second for a given tenancy. + + + :param str key_id: (required) + The OCID of the key. + + :param str key_version_id: (required) + The OCID of the key version. + + :param ScheduleKeyVersionDeletionDetails schedule_key_version_deletion_details: (required) + ScheduleKeyVersionDeletionDetails + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call for a + resource, set the `if-match` parameter to the value of the etag from a + previous GET or POST response for that resource. The resource will be + updated or deleted only if the etag you provide matches the resource's + current etag value. + + :param str opc_request_id: (optional) + Unique identifier for the request. If provided, the returned request ID + will include this value. Otherwise, a random request ID will be + generated by the service. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case + of a timeout or server error without risk of executing that same action + again. Retry tokens expire after 24 hours, but can be invalidated + before then due to conflicting operations (e.g., if a resource has been + deleted and purged from the system, then a retry of the original + creation request may be rejected). + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.key_management.models.KeyVersion` + :rtype: :class:`~oci.response.Response` + """ + resource_path = "/20180608/keys/{keyId}/keyVersions/{keyVersionId}/actions/scheduleDeletion" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "if_match", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "schedule_key_version_deletion got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "keyId": key_id, + "keyVersionId": key_version_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.retry_strategy + if kwargs.get('retry_strategy'): + retry_strategy = kwargs.get('retry_strategy') + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=schedule_key_version_deletion_details, + response_type="KeyVersion") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=schedule_key_version_deletion_details, + response_type="KeyVersion") + def update_key(self, key_id, update_key_details, **kwargs): """ Updates a key's properties. - Updates the properties of a key. Specifically, you can update the + Updates the properties of a master encryption key. Specifically, you can update the `displayName`, `freeformTags`, and `definedTags` properties. Furthermore, - the key must in an `ACTIVE` or `CREATING` state to be updated. + the key must in an ENABLED or CREATING state to be updated. + + As a management operation, this call is subject to a Key Management limit that applies to the total number + of requests across all management write operations. Key Management might throttle this call to reject an + otherwise valid request when the total rate of management write operations exceeds 10 requests per second + for a given tenancy. :param str key_id: (required) diff --git a/src/oci/key_management/kms_management_client_composite_operations.py b/src/oci/key_management/kms_management_client_composite_operations.py index 5e55745d3a..e1dbbad2b7 100644 --- a/src/oci/key_management/kms_management_client_composite_operations.py +++ b/src/oci/key_management/kms_management_client_composite_operations.py @@ -60,6 +60,47 @@ def cancel_key_deletion_and_wait_for_state(self, key_id, wait_for_states=[], ope except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def cancel_key_version_deletion_and_wait_for_state(self, key_id, key_version_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.key_management.KmsManagementClient.cancel_key_version_deletion` and waits for the :py:class:`~oci.key_management.models.KeyVersion` acted upon + to enter the given state(s). + + :param str key_id: (required) + The OCID of the key. + + :param str key_version_id: (required) + The OCID of the key version. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.key_management.models.KeyVersion.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.key_management.KmsManagementClient.cancel_key_version_deletion` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.cancel_key_version_deletion(key_id, key_version_id, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_key_version(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def create_key_and_wait_for_state(self, create_key_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.key_management.KmsManagementClient.create_key` and waits for the :py:class:`~oci.key_management.models.Key` acted upon @@ -98,6 +139,44 @@ def create_key_and_wait_for_state(self, create_key_details, wait_for_states=[], except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def create_key_version_and_wait_for_state(self, key_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.key_management.KmsManagementClient.create_key_version` and waits for the :py:class:`~oci.key_management.models.KeyVersion` acted upon + to enter the given state(s). + + :param str key_id: (required) + The OCID of the key. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.key_management.models.KeyVersion.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.key_management.KmsManagementClient.create_key_version` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.create_key_version(key_id, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_key_version(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def disable_key_and_wait_for_state(self, key_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.key_management.KmsManagementClient.disable_key` and waits for the :py:class:`~oci.key_management.models.Key` acted upon @@ -215,6 +294,50 @@ def schedule_key_deletion_and_wait_for_state(self, key_id, schedule_key_deletion except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def schedule_key_version_deletion_and_wait_for_state(self, key_id, key_version_id, schedule_key_version_deletion_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.key_management.KmsManagementClient.schedule_key_version_deletion` and waits for the :py:class:`~oci.key_management.models.KeyVersion` acted upon + to enter the given state(s). + + :param str key_id: (required) + The OCID of the key. + + :param str key_version_id: (required) + The OCID of the key version. + + :param ScheduleKeyVersionDeletionDetails schedule_key_version_deletion_details: (required) + ScheduleKeyVersionDeletionDetails + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.key_management.models.KeyVersion.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.key_management.KmsManagementClient.schedule_key_version_deletion` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.schedule_key_version_deletion(key_id, key_version_id, schedule_key_version_deletion_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_key_version(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def update_key_and_wait_for_state(self, key_id, update_key_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.key_management.KmsManagementClient.update_key` and waits for the :py:class:`~oci.key_management.models.Key` acted upon diff --git a/src/oci/key_management/kms_vault_client.py b/src/oci/key_management/kms_vault_client.py index 691a587eb6..9f592a06e1 100644 --- a/src/oci/key_management/kms_vault_client.py +++ b/src/oci/key_management/kms_vault_client.py @@ -74,6 +74,7 @@ def __init__(self, config, **kwargs): 'service_endpoint': kwargs.get('service_endpoint'), 'timeout': kwargs.get('timeout'), 'base_path': '/', + 'service_endpoint_template': 'https://kms.{region}.{secondLevelDomain}', 'skip_deserialization': kwargs.get('skip_deserialization', False) } self.base_client = BaseClient("kms_vault", config, signer, key_management_type_mapping, **base_client_init_kwargs) @@ -83,9 +84,14 @@ def cancel_vault_deletion(self, vault_id, **kwargs): """ Cancels the scheduled deletion of a vault. Cancels the scheduled deletion of the specified vault. Canceling a scheduled deletion - restores the vault and all keys in it to the respective states they were in before - the deletion was scheduled. All the keys that have already been scheduled deletion before the - scheduled deletion of the vault will also remain in their state and timeOfDeletion. + restores the vault and all keys in it to their respective states from before their + scheduled deletion. All keys that were scheduled for deletion prior to vault + deletion retain their lifecycle state and time of deletion. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning write operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + write operations exceeds 10 requests per second for a given tenancy. :param str vault_id: (required) @@ -180,8 +186,18 @@ def cancel_vault_deletion(self, vault_id, **kwargs): def change_vault_compartment(self, vault_id, change_vault_compartment_details, **kwargs): """ - Moves a vault into a different compartment. When provided, If-Match is checked against ETag values of the resource. - Moves a vault into a different compartment. When provided, If-Match is checked against ETag values of the resource. + Moves a vault into a different compartment. + Moves a vault into a different compartment within the same tenancy. For information about + moving resources between compartments, see `Moving Resources to a Different Compartment`__. + + When provided, if-match is checked against the ETag values of the resource. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning write operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + write operations exceeds 10 requests per second for a given tenancy. + + __ https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes :param str vault_id: (required) @@ -279,10 +295,15 @@ def change_vault_compartment(self, vault_id, change_vault_compartment_details, * def create_vault(self, create_vault_details, **kwargs): """ Creates a new vault. - Creates a new vault. The type of vault you create determines key - placement, pricing, and available options. Options include storage - isolation, a dedicated service endpoint instead of a shared service - endpoint for API calls, and a dedicated hardware security module (HSM) or a multitenant HSM. + Creates a new vault. The type of vault you create determines key placement, pricing, and + available options. Options include storage isolation, a dedicated service endpoint instead + of a shared service endpoint for API calls, and either a dedicated hardware security module + (HSM) or a multitenant HSM. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning write operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + write operations exceeds 10 requests per second for a given tenancy. :param CreateVaultDetails create_vault_details: (required) @@ -361,6 +382,11 @@ def get_vault(self, vault_id, **kwargs): Gets details about a vault. Gets the specified vault's configuration information. + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning read operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + read operations exceeds 10 requests per second for a given tenancy. + :param str vault_id: (required) The OCID of the vault. @@ -436,6 +462,11 @@ def list_vaults(self, compartment_id, **kwargs): Lists vaults in the compartment. Lists the vaults in the specified compartment. + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning read operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + read operations exceeds 10 requests per second for a given tenancy. + :param str compartment_id: (required) The OCID of the compartment. @@ -454,7 +485,7 @@ def list_vaults(self, compartment_id, **kwargs): :param str sort_by: (optional) The field to sort by. You can specify only one sort order. The default - order for TIMECREATED is descending. The default order for DISPLAYNAME + order for `TIMECREATED` is descending. The default order for `DISPLAYNAME` is ascending. Allowed values are: "TIMECREATED", "DISPLAYNAME" @@ -545,12 +576,16 @@ def list_vaults(self, compartment_id, **kwargs): def schedule_vault_deletion(self, vault_id, schedule_vault_deletion_details, **kwargs): """ Schedules the deletion of a vault. - Schedules the deletion of the specified vault. This sets the state of the vault and - keys that are not scheduled deletion in it to `PENDING_DELETION` and then deletes them - after the retention period ends. - The state and the timeOfDeletion of the keys that have already been scheduled for deletion - will not change. If any keys in it are scheduled for deletion after the specified timeOfDeletion - for the vault, the call will be rejected with status code 409. + Schedules the deletion of the specified vault. This sets the lifecycle state of the vault and all keys in it + that are not already scheduled for deletion to PENDING_DELETION and then deletes them after the + retention period ends. The lifecycle state and time of deletion for keys already scheduled for deletion won't + change. If any keys in the vault are scheduled to be deleted after the specified time of + deletion for the vault, the call is rejected with the error code 409. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning write operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + write operations exceeds 10 requests per second for a given tenancy. :param str vault_id: (required) @@ -653,7 +688,12 @@ def update_vault(self, vault_id, update_vault_details, **kwargs): Updates the properties of a vault. Updates the properties of a vault. Specifically, you can update the `displayName`, `freeformTags`, and `definedTags` properties. Furthermore, - the vault must be in an `ACTIVE` or `CREATING` state to be updated. + the vault must be in an ACTIVE or CREATING state to be updated. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning write operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + write operations exceeds 10 requests per second for a given tenancy. :param str vault_id: (required) diff --git a/src/oci/key_management/models/__init__.py b/src/oci/key_management/models/__init__.py index b30b0b1378..9c6b6cd259 100644 --- a/src/oci/key_management/models/__init__.py +++ b/src/oci/key_management/models/__init__.py @@ -13,17 +13,22 @@ from .encrypted_data import EncryptedData from .generate_key_details import GenerateKeyDetails from .generated_key import GeneratedKey +from .import_key_details import ImportKeyDetails +from .import_key_version_details import ImportKeyVersionDetails from .key import Key from .key_shape import KeyShape from .key_summary import KeySummary from .key_version import KeyVersion from .key_version_summary import KeyVersionSummary from .schedule_key_deletion_details import ScheduleKeyDeletionDetails +from .schedule_key_version_deletion_details import ScheduleKeyVersionDeletionDetails from .schedule_vault_deletion_details import ScheduleVaultDeletionDetails from .update_key_details import UpdateKeyDetails from .update_vault_details import UpdateVaultDetails from .vault import Vault from .vault_summary import VaultSummary +from .wrapped_import_key import WrappedImportKey +from .wrapping_key import WrappingKey # Maps type names to classes for key_management services. key_management_type_mapping = { @@ -37,15 +42,20 @@ "EncryptedData": EncryptedData, "GenerateKeyDetails": GenerateKeyDetails, "GeneratedKey": GeneratedKey, + "ImportKeyDetails": ImportKeyDetails, + "ImportKeyVersionDetails": ImportKeyVersionDetails, "Key": Key, "KeyShape": KeyShape, "KeySummary": KeySummary, "KeyVersion": KeyVersion, "KeyVersionSummary": KeyVersionSummary, "ScheduleKeyDeletionDetails": ScheduleKeyDeletionDetails, + "ScheduleKeyVersionDeletionDetails": ScheduleKeyVersionDeletionDetails, "ScheduleVaultDeletionDetails": ScheduleVaultDeletionDetails, "UpdateKeyDetails": UpdateKeyDetails, "UpdateVaultDetails": UpdateVaultDetails, "Vault": Vault, - "VaultSummary": VaultSummary + "VaultSummary": VaultSummary, + "WrappedImportKey": WrappedImportKey, + "WrappingKey": WrappingKey } diff --git a/src/oci/key_management/models/change_key_compartment_details.py b/src/oci/key_management/models/change_key_compartment_details.py index 42466286cb..b5503dd21f 100644 --- a/src/oci/key_management/models/change_key_compartment_details.py +++ b/src/oci/key_management/models/change_key_compartment_details.py @@ -36,7 +36,7 @@ def __init__(self, **kwargs): def compartment_id(self): """ **[Required]** Gets the compartment_id of this ChangeKeyCompartmentDetails. - The `OCID`__ of the compartment into which the key should be moved. + The `OCID`__ of the compartment to move the key to. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm @@ -50,7 +50,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this ChangeKeyCompartmentDetails. - The `OCID`__ of the compartment into which the key should be moved. + The `OCID`__ of the compartment to move the key to. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm diff --git a/src/oci/key_management/models/change_vault_compartment_details.py b/src/oci/key_management/models/change_vault_compartment_details.py index 5e1c909b6f..55b36c0e8c 100644 --- a/src/oci/key_management/models/change_vault_compartment_details.py +++ b/src/oci/key_management/models/change_vault_compartment_details.py @@ -36,7 +36,7 @@ def __init__(self, **kwargs): def compartment_id(self): """ **[Required]** Gets the compartment_id of this ChangeVaultCompartmentDetails. - The `OCID`__ of the compartment into which the vault should be moved. + The `OCID`__ of the compartment to move the vault to. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm @@ -50,7 +50,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this ChangeVaultCompartmentDetails. - The `OCID`__ of the compartment into which the vault should be moved. + The `OCID`__ of the compartment to move the vault to. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm diff --git a/src/oci/key_management/models/create_key_details.py b/src/oci/key_management/models/create_key_details.py index 13046eab53..fd7a655db9 100644 --- a/src/oci/key_management/models/create_key_details.py +++ b/src/oci/key_management/models/create_key_details.py @@ -64,7 +64,7 @@ def __init__(self, **kwargs): def compartment_id(self): """ **[Required]** Gets the compartment_id of this CreateKeyDetails. - The OCID of the compartment that contains this key. + The OCID of the compartment that contains this master encryption key. :return: The compartment_id of this CreateKeyDetails. @@ -76,7 +76,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this CreateKeyDetails. - The OCID of the compartment that contains this key. + The OCID of the compartment that contains this master encryption key. :param compartment_id: The compartment_id of this CreateKeyDetails. @@ -88,8 +88,11 @@ def compartment_id(self, compartment_id): def defined_tags(self): """ Gets the defined_tags of this CreateKeyDetails. - Usage of predefined tag keys. These predefined keys are scoped to namespaces. - Example: `{\"foo-namespace\": {\"bar-key\": \"foo-value\"}}` + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :return: The defined_tags of this CreateKeyDetails. @@ -101,8 +104,11 @@ def defined_tags(self): def defined_tags(self, defined_tags): """ Sets the defined_tags of this CreateKeyDetails. - Usage of predefined tag keys. These predefined keys are scoped to namespaces. - Example: `{\"foo-namespace\": {\"bar-key\": \"foo-value\"}}` + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :param defined_tags: The defined_tags of this CreateKeyDetails. @@ -140,9 +146,11 @@ def display_name(self, display_name): def freeform_tags(self): """ Gets the freeform_tags of this CreateKeyDetails. - Simple key-value pair that is applied without any predefined name, type, or scope. - Exists for cross-compatibility only. - Example: `{\"bar-key\": \"value\"}` + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + For more information, see `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :return: The freeform_tags of this CreateKeyDetails. @@ -154,9 +162,11 @@ def freeform_tags(self): def freeform_tags(self, freeform_tags): """ Sets the freeform_tags of this CreateKeyDetails. - Simple key-value pair that is applied without any predefined name, type, or scope. - Exists for cross-compatibility only. - Example: `{\"bar-key\": \"value\"}` + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + For more information, see `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :param freeform_tags: The freeform_tags of this CreateKeyDetails. diff --git a/src/oci/key_management/models/create_vault_details.py b/src/oci/key_management/models/create_vault_details.py index 251c5ee9a3..20e830b7e7 100644 --- a/src/oci/key_management/models/create_vault_details.py +++ b/src/oci/key_management/models/create_vault_details.py @@ -16,6 +16,10 @@ class CreateVaultDetails(object): #: This constant has a value of "VIRTUAL_PRIVATE" VAULT_TYPE_VIRTUAL_PRIVATE = "VIRTUAL_PRIVATE" + #: A constant which can be used with the vault_type property of a CreateVaultDetails. + #: This constant has a value of "DEFAULT" + VAULT_TYPE_DEFAULT = "DEFAULT" + def __init__(self, **kwargs): """ Initializes a new CreateVaultDetails object with values from keyword arguments. @@ -39,7 +43,7 @@ def __init__(self, **kwargs): :param vault_type: The value to assign to the vault_type property of this CreateVaultDetails. - Allowed values for this property are: "VIRTUAL_PRIVATE" + Allowed values for this property are: "VIRTUAL_PRIVATE", "DEFAULT" :type vault_type: str """ @@ -93,8 +97,11 @@ def compartment_id(self, compartment_id): def defined_tags(self): """ Gets the defined_tags of this CreateVaultDetails. - Usage of predefined tag keys. These predefined keys are scoped to namespaces. - Example: `{\"foo-namespace\": {\"bar-key\": \"foo-value\"}}` + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :return: The defined_tags of this CreateVaultDetails. @@ -106,8 +113,11 @@ def defined_tags(self): def defined_tags(self, defined_tags): """ Sets the defined_tags of this CreateVaultDetails. - Usage of predefined tag keys. These predefined keys are scoped to namespaces. - Example: `{\"foo-namespace\": {\"bar-key\": \"foo-value\"}}` + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :param defined_tags: The defined_tags of this CreateVaultDetails. @@ -145,9 +155,11 @@ def display_name(self, display_name): def freeform_tags(self): """ Gets the freeform_tags of this CreateVaultDetails. - Simple key-value pair that is applied without any predefined name, type, or scope. - Exists for cross-compatibility only. - Example: `{\"bar-key\": \"value\"}` + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + For more information, see `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :return: The freeform_tags of this CreateVaultDetails. @@ -159,9 +171,11 @@ def freeform_tags(self): def freeform_tags(self, freeform_tags): """ Sets the freeform_tags of this CreateVaultDetails. - Simple key-value pair that is applied without any predefined name, type, or scope. - Exists for cross-compatibility only. - Example: `{\"bar-key\": \"value\"}` + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + For more information, see `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :param freeform_tags: The freeform_tags of this CreateVaultDetails. @@ -175,7 +189,7 @@ def vault_type(self): **[Required]** Gets the vault_type of this CreateVaultDetails. The type of vault to create. Each type of vault stores the key with different degrees of isolation and has different options and pricing. - Allowed values for this property are: "VIRTUAL_PRIVATE" + Allowed values for this property are: "VIRTUAL_PRIVATE", "DEFAULT" :return: The vault_type of this CreateVaultDetails. @@ -193,7 +207,7 @@ def vault_type(self, vault_type): :param vault_type: The vault_type of this CreateVaultDetails. :type: str """ - allowed_values = ["VIRTUAL_PRIVATE"] + allowed_values = ["VIRTUAL_PRIVATE", "DEFAULT"] if not value_allowed_none_or_none_sentinel(vault_type, allowed_values): raise ValueError( "Invalid value for `vault_type`, must be None or one of {0}" diff --git a/src/oci/key_management/models/decrypt_data_details.py b/src/oci/key_management/models/decrypt_data_details.py index 3a981e7b7c..ff36d03ff0 100644 --- a/src/oci/key_management/models/decrypt_data_details.py +++ b/src/oci/key_management/models/decrypt_data_details.py @@ -57,9 +57,8 @@ def __init__(self, **kwargs): def associated_data(self): """ Gets the associated_data of this DecryptDataDetails. - Information that can be used to provide an encryption context for the - encrypted data. The length of the string representation of the associatedData - must be fewer than 4096 characters. + Information that can be used to provide an encryption context for the encrypted data. + The length of the string representation of the associated data must be fewer than 4096 characters. :return: The associated_data of this DecryptDataDetails. @@ -71,9 +70,8 @@ def associated_data(self): def associated_data(self, associated_data): """ Sets the associated_data of this DecryptDataDetails. - Information that can be used to provide an encryption context for the - encrypted data. The length of the string representation of the associatedData - must be fewer than 4096 characters. + Information that can be used to provide an encryption context for the encrypted data. + The length of the string representation of the associated data must be fewer than 4096 characters. :param associated_data: The associated_data of this DecryptDataDetails. @@ -133,8 +131,8 @@ def key_id(self, key_id): def logging_context(self): """ Gets the logging_context of this DecryptDataDetails. - Information that can be used to provide context for audit logging. It is a map that contains any addtional - data the users may have and will be added to the audit logs (if audit logging is enabled) + Information that provides context for audit logging. You can provide this additional + data as key-value pairs to include in audit logs when audit logging is enabled. :return: The logging_context of this DecryptDataDetails. @@ -146,8 +144,8 @@ def logging_context(self): def logging_context(self, logging_context): """ Sets the logging_context of this DecryptDataDetails. - Information that can be used to provide context for audit logging. It is a map that contains any addtional - data the users may have and will be added to the audit logs (if audit logging is enabled) + Information that provides context for audit logging. You can provide this additional + data as key-value pairs to include in audit logs when audit logging is enabled. :param logging_context: The logging_context of this DecryptDataDetails. diff --git a/src/oci/key_management/models/encrypt_data_details.py b/src/oci/key_management/models/encrypt_data_details.py index 34c9c6aa05..0da10b2207 100644 --- a/src/oci/key_management/models/encrypt_data_details.py +++ b/src/oci/key_management/models/encrypt_data_details.py @@ -58,7 +58,7 @@ def associated_data(self): """ Gets the associated_data of this EncryptDataDetails. Information that can be used to provide an encryption context for the - encrypted data. The length of the string representation of the associatedData + encrypted data. The length of the string representation of the associated data must be fewer than 4096 characters. @@ -72,7 +72,7 @@ def associated_data(self, associated_data): """ Sets the associated_data of this EncryptDataDetails. Information that can be used to provide an encryption context for the - encrypted data. The length of the string representation of the associatedData + encrypted data. The length of the string representation of the associated data must be fewer than 4096 characters. @@ -109,8 +109,8 @@ def key_id(self, key_id): def logging_context(self): """ Gets the logging_context of this EncryptDataDetails. - Information that can be used to provide context for audit logging. It is a map that contains any addtional - data the users may have and will be added to the audit logs (if audit logging is enabled) + Information that provides context for audit logging. You can provide this additional + data as key-value pairs to include in the audit logs when audit logging is enabled. :return: The logging_context of this EncryptDataDetails. @@ -122,8 +122,8 @@ def logging_context(self): def logging_context(self, logging_context): """ Sets the logging_context of this EncryptDataDetails. - Information that can be used to provide context for audit logging. It is a map that contains any addtional - data the users may have and will be added to the audit logs (if audit logging is enabled) + Information that provides context for audit logging. You can provide this additional + data as key-value pairs to include in the audit logs when audit logging is enabled. :param logging_context: The logging_context of this EncryptDataDetails. diff --git a/src/oci/key_management/models/generate_key_details.py b/src/oci/key_management/models/generate_key_details.py index cf830d8bbc..81f551d3f4 100644 --- a/src/oci/key_management/models/generate_key_details.py +++ b/src/oci/key_management/models/generate_key_details.py @@ -64,9 +64,9 @@ def __init__(self, **kwargs): def associated_data(self): """ Gets the associated_data of this GenerateKeyDetails. - Information that can be used to provide an encryption context for the - encrypted data. The length of the string representation of the associatedData - must be fewer than 4096 characters. + Information that can be used to provide an encryption context for the encrypted data. + The length of the string representation of the associated data must be fewer than 4096 + characters. :return: The associated_data of this GenerateKeyDetails. @@ -78,9 +78,9 @@ def associated_data(self): def associated_data(self, associated_data): """ Sets the associated_data of this GenerateKeyDetails. - Information that can be used to provide an encryption context for the - encrypted data. The length of the string representation of the associatedData - must be fewer than 4096 characters. + Information that can be used to provide an encryption context for the encrypted data. + The length of the string representation of the associated data must be fewer than 4096 + characters. :param associated_data: The associated_data of this GenerateKeyDetails. @@ -160,8 +160,8 @@ def key_shape(self, key_shape): def logging_context(self): """ Gets the logging_context of this GenerateKeyDetails. - Information that can be used to provide context for audit logging. It is a map that contains any addtional - data the users may have and will be added to the audit logs (if audit logging is enabled) + Information that provides context for audit logging. You can provide this additional + data by formatting it as key-value pairs to include in audit logs when audit logging is enabled. :return: The logging_context of this GenerateKeyDetails. @@ -173,8 +173,8 @@ def logging_context(self): def logging_context(self, logging_context): """ Sets the logging_context of this GenerateKeyDetails. - Information that can be used to provide context for audit logging. It is a map that contains any addtional - data the users may have and will be added to the audit logs (if audit logging is enabled) + Information that provides context for audit logging. You can provide this additional + data by formatting it as key-value pairs to include in audit logs when audit logging is enabled. :param logging_context: The logging_context of this GenerateKeyDetails. diff --git a/src/oci/key_management/models/generated_key.py b/src/oci/key_management/models/generated_key.py index 50d0803403..6f12ae21ba 100644 --- a/src/oci/key_management/models/generated_key.py +++ b/src/oci/key_management/models/generated_key.py @@ -50,7 +50,7 @@ def __init__(self, **kwargs): def ciphertext(self): """ **[Required]** Gets the ciphertext of this GeneratedKey. - The encrypted generated data encryption key. + The encrypted data encryption key generated from a master encryption key. :return: The ciphertext of this GeneratedKey. @@ -62,7 +62,7 @@ def ciphertext(self): def ciphertext(self, ciphertext): """ Sets the ciphertext of this GeneratedKey. - The encrypted generated data encryption key. + The encrypted data encryption key generated from a master encryption key. :param ciphertext: The ciphertext of this GeneratedKey. @@ -74,10 +74,11 @@ def ciphertext(self, ciphertext): def plaintext(self): """ Gets the plaintext of this GeneratedKey. - The plaintext generated data encryption key, a base64-encoded - sequence of random bytes, which is included if the - GenerateDataEncryptionKey request includes the \"includePlaintextKey\" - parameter and sets its value to 'true'. + The plaintext data encryption key, a base64-encoded sequence of random bytes, which is + included if the `GenerateDataEncryptionKey`__ + request includes the `includePlaintextKey` parameter and sets its value to \"true\". + + __ https://docs.cloud.oracle.com/api/#/en/key/release/GeneratedKey/GenerateDataEncryptionKey :return: The plaintext of this GeneratedKey. @@ -89,10 +90,11 @@ def plaintext(self): def plaintext(self, plaintext): """ Sets the plaintext of this GeneratedKey. - The plaintext generated data encryption key, a base64-encoded - sequence of random bytes, which is included if the - GenerateDataEncryptionKey request includes the \"includePlaintextKey\" - parameter and sets its value to 'true'. + The plaintext data encryption key, a base64-encoded sequence of random bytes, which is + included if the `GenerateDataEncryptionKey`__ + request includes the `includePlaintextKey` parameter and sets its value to \"true\". + + __ https://docs.cloud.oracle.com/api/#/en/key/release/GeneratedKey/GenerateDataEncryptionKey :param plaintext: The plaintext of this GeneratedKey. @@ -104,9 +106,11 @@ def plaintext(self, plaintext): def plaintext_checksum(self): """ Gets the plaintext_checksum of this GeneratedKey. - The checksum of the plaintext generated data encryption key, which - is included if the GenerateDataEncryptionKey request includes the - \"includePlaintextKey parameter and sets its value to 'true'. + The checksum of the plaintext data encryption key, which is included if the + `GenerateDataEncryptionKey`__ + request includes the `includePlaintextKey` parameter and sets its value to \"true\". + + __ https://docs.cloud.oracle.com/api/#/en/key/release/GeneratedKey/GenerateDataEncryptionKey :return: The plaintext_checksum of this GeneratedKey. @@ -118,9 +122,11 @@ def plaintext_checksum(self): def plaintext_checksum(self, plaintext_checksum): """ Sets the plaintext_checksum of this GeneratedKey. - The checksum of the plaintext generated data encryption key, which - is included if the GenerateDataEncryptionKey request includes the - \"includePlaintextKey parameter and sets its value to 'true'. + The checksum of the plaintext data encryption key, which is included if the + `GenerateDataEncryptionKey`__ + request includes the `includePlaintextKey` parameter and sets its value to \"true\". + + __ https://docs.cloud.oracle.com/api/#/en/key/release/GeneratedKey/GenerateDataEncryptionKey :param plaintext_checksum: The plaintext_checksum of this GeneratedKey. diff --git a/src/oci/key_management/models/import_key_details.py b/src/oci/key_management/models/import_key_details.py new file mode 100644 index 0000000000..5041c33dca --- /dev/null +++ b/src/oci/key_management/models/import_key_details.py @@ -0,0 +1,224 @@ +# coding: utf-8 +# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ImportKeyDetails(object): + """ + ImportKeyDetails model. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ImportKeyDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param compartment_id: + The value to assign to the compartment_id property of this ImportKeyDetails. + :type compartment_id: str + + :param defined_tags: + The value to assign to the defined_tags property of this ImportKeyDetails. + :type defined_tags: dict(str, dict(str, object)) + + :param display_name: + The value to assign to the display_name property of this ImportKeyDetails. + :type display_name: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this ImportKeyDetails. + :type freeform_tags: dict(str, str) + + :param key_shape: + The value to assign to the key_shape property of this ImportKeyDetails. + :type key_shape: KeyShape + + :param wrapped_import_key: + The value to assign to the wrapped_import_key property of this ImportKeyDetails. + :type wrapped_import_key: WrappedImportKey + + """ + self.swagger_types = { + 'compartment_id': 'str', + 'defined_tags': 'dict(str, dict(str, object))', + 'display_name': 'str', + 'freeform_tags': 'dict(str, str)', + 'key_shape': 'KeyShape', + 'wrapped_import_key': 'WrappedImportKey' + } + + self.attribute_map = { + 'compartment_id': 'compartmentId', + 'defined_tags': 'definedTags', + 'display_name': 'displayName', + 'freeform_tags': 'freeformTags', + 'key_shape': 'keyShape', + 'wrapped_import_key': 'wrappedImportKey' + } + + self._compartment_id = None + self._defined_tags = None + self._display_name = None + self._freeform_tags = None + self._key_shape = None + self._wrapped_import_key = None + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ImportKeyDetails. + The OCID of the compartment that contains this key. + + + :return: The compartment_id of this ImportKeyDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ImportKeyDetails. + The OCID of the compartment that contains this key. + + + :param compartment_id: The compartment_id of this ImportKeyDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def defined_tags(self): + """ + Gets the defined_tags of this ImportKeyDetails. + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{\"foo-namespace\": {\"bar-key\": \"foo-value\"}}` + + + :return: The defined_tags of this ImportKeyDetails. + :rtype: dict(str, dict(str, object)) + """ + return self._defined_tags + + @defined_tags.setter + def defined_tags(self, defined_tags): + """ + Sets the defined_tags of this ImportKeyDetails. + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{\"foo-namespace\": {\"bar-key\": \"foo-value\"}}` + + + :param defined_tags: The defined_tags of this ImportKeyDetails. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this ImportKeyDetails. + A user-friendly name for the key. It does not have to be unique, and it is changeable. + Avoid entering confidential information. + + + :return: The display_name of this ImportKeyDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this ImportKeyDetails. + A user-friendly name for the key. It does not have to be unique, and it is changeable. + Avoid entering confidential information. + + + :param display_name: The display_name of this ImportKeyDetails. + :type: str + """ + self._display_name = display_name + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this ImportKeyDetails. + Simple key-value pair that is applied without any predefined name, type, or scope. + Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this ImportKeyDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this ImportKeyDetails. + Simple key-value pair that is applied without any predefined name, type, or scope. + Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this ImportKeyDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def key_shape(self): + """ + **[Required]** Gets the key_shape of this ImportKeyDetails. + + :return: The key_shape of this ImportKeyDetails. + :rtype: KeyShape + """ + return self._key_shape + + @key_shape.setter + def key_shape(self, key_shape): + """ + Sets the key_shape of this ImportKeyDetails. + + :param key_shape: The key_shape of this ImportKeyDetails. + :type: KeyShape + """ + self._key_shape = key_shape + + @property + def wrapped_import_key(self): + """ + **[Required]** Gets the wrapped_import_key of this ImportKeyDetails. + + :return: The wrapped_import_key of this ImportKeyDetails. + :rtype: WrappedImportKey + """ + return self._wrapped_import_key + + @wrapped_import_key.setter + def wrapped_import_key(self, wrapped_import_key): + """ + Sets the wrapped_import_key of this ImportKeyDetails. + + :param wrapped_import_key: The wrapped_import_key of this ImportKeyDetails. + :type: WrappedImportKey + """ + self._wrapped_import_key = wrapped_import_key + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/key_management/models/import_key_version_details.py b/src/oci/key_management/models/import_key_version_details.py new file mode 100644 index 0000000000..1823889445 --- /dev/null +++ b/src/oci/key_management/models/import_key_version_details.py @@ -0,0 +1,133 @@ +# coding: utf-8 +# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ImportKeyVersionDetails(object): + """ + ImportKeyVersionDetails model. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ImportKeyVersionDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param defined_tags: + The value to assign to the defined_tags property of this ImportKeyVersionDetails. + :type defined_tags: dict(str, dict(str, object)) + + :param freeform_tags: + The value to assign to the freeform_tags property of this ImportKeyVersionDetails. + :type freeform_tags: dict(str, str) + + :param wrapped_import_key: + The value to assign to the wrapped_import_key property of this ImportKeyVersionDetails. + :type wrapped_import_key: WrappedImportKey + + """ + self.swagger_types = { + 'defined_tags': 'dict(str, dict(str, object))', + 'freeform_tags': 'dict(str, str)', + 'wrapped_import_key': 'WrappedImportKey' + } + + self.attribute_map = { + 'defined_tags': 'definedTags', + 'freeform_tags': 'freeformTags', + 'wrapped_import_key': 'wrappedImportKey' + } + + self._defined_tags = None + self._freeform_tags = None + self._wrapped_import_key = None + + @property + def defined_tags(self): + """ + Gets the defined_tags of this ImportKeyVersionDetails. + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{\"foo-namespace\": {\"bar-key\": \"foo-value\"}}` + + + :return: The defined_tags of this ImportKeyVersionDetails. + :rtype: dict(str, dict(str, object)) + """ + return self._defined_tags + + @defined_tags.setter + def defined_tags(self, defined_tags): + """ + Sets the defined_tags of this ImportKeyVersionDetails. + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{\"foo-namespace\": {\"bar-key\": \"foo-value\"}}` + + + :param defined_tags: The defined_tags of this ImportKeyVersionDetails. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this ImportKeyVersionDetails. + Simple key-value pair that is applied without any predefined name, type, or scope. + Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this ImportKeyVersionDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this ImportKeyVersionDetails. + Simple key-value pair that is applied without any predefined name, type, or scope. + Exists for cross-compatibility only. + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this ImportKeyVersionDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def wrapped_import_key(self): + """ + **[Required]** Gets the wrapped_import_key of this ImportKeyVersionDetails. + + :return: The wrapped_import_key of this ImportKeyVersionDetails. + :rtype: WrappedImportKey + """ + return self._wrapped_import_key + + @wrapped_import_key.setter + def wrapped_import_key(self, wrapped_import_key): + """ + Sets the wrapped_import_key of this ImportKeyVersionDetails. + + :param wrapped_import_key: The wrapped_import_key of this ImportKeyVersionDetails. + :type: WrappedImportKey + """ + self._wrapped_import_key = wrapped_import_key + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/key_management/models/key.py b/src/oci/key_management/models/key.py index 3cbe39e856..b958be9ddc 100644 --- a/src/oci/key_management/models/key.py +++ b/src/oci/key_management/models/key.py @@ -152,7 +152,7 @@ def __init__(self, **kwargs): def compartment_id(self): """ **[Required]** Gets the compartment_id of this Key. - The OCID of the compartment that contains this key. + The OCID of the compartment that contains this master encryption key. :return: The compartment_id of this Key. @@ -164,7 +164,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this Key. - The OCID of the compartment that contains this key. + The OCID of the compartment that contains this master encryption key. :param compartment_id: The compartment_id of this Key. @@ -176,9 +176,9 @@ def compartment_id(self, compartment_id): def current_key_version(self): """ **[Required]** Gets the current_key_version of this Key. - The OCID of the KeyVersion resource used in cryptographic operations. During key rotation, service might be in a transitional state - where this or a newer KeyVersion are used intermittently. The currentKeyVersion field is updated when the service is guaranteed to - use the new KeyVersion for all subsequent encryption operations. + The OCID of the key version used in cryptographic operations. During key rotation, the service might be + in a transitional state where this or a newer key version are used intermittently. The `currentKeyVersion` + field is updated when the service is guaranteed to use the new key version for all subsequent encryption operations. :return: The current_key_version of this Key. @@ -190,9 +190,9 @@ def current_key_version(self): def current_key_version(self, current_key_version): """ Sets the current_key_version of this Key. - The OCID of the KeyVersion resource used in cryptographic operations. During key rotation, service might be in a transitional state - where this or a newer KeyVersion are used intermittently. The currentKeyVersion field is updated when the service is guaranteed to - use the new KeyVersion for all subsequent encryption operations. + The OCID of the key version used in cryptographic operations. During key rotation, the service might be + in a transitional state where this or a newer key version are used intermittently. The `currentKeyVersion` + field is updated when the service is guaranteed to use the new key version for all subsequent encryption operations. :param current_key_version: The current_key_version of this Key. @@ -204,8 +204,11 @@ def current_key_version(self, current_key_version): def defined_tags(self): """ Gets the defined_tags of this Key. - Usage of predefined tag keys. These predefined keys are scoped to namespaces. - Example: `{\"foo-namespace\": {\"bar-key\": \"foo-value\"}}` + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :return: The defined_tags of this Key. @@ -217,8 +220,11 @@ def defined_tags(self): def defined_tags(self, defined_tags): """ Sets the defined_tags of this Key. - Usage of predefined tag keys. These predefined keys are scoped to namespaces. - Example: `{\"foo-namespace\": {\"bar-key\": \"foo-value\"}}` + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :param defined_tags: The defined_tags of this Key. @@ -256,9 +262,11 @@ def display_name(self, display_name): def freeform_tags(self): """ Gets the freeform_tags of this Key. - Simple key-value pair that is applied without any predefined name, type, or scope. - Exists for cross-compatibility only. - Example: `{\"bar-key\": \"value\"}` + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + For more information, see `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :return: The freeform_tags of this Key. @@ -270,9 +278,11 @@ def freeform_tags(self): def freeform_tags(self, freeform_tags): """ Sets the freeform_tags of this Key. - Simple key-value pair that is applied without any predefined name, type, or scope. - Exists for cross-compatibility only. - Example: `{\"bar-key\": \"value\"}` + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + For more information, see `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :param freeform_tags: The freeform_tags of this Key. @@ -394,7 +404,7 @@ def time_created(self, time_created): def time_of_deletion(self): """ Gets the time_of_deletion of this Key. - An optional property for the deletion time of the key, expressed in `RFC 3339`__ timestamp format. + An optional property indicating when to delete the key, expressed in `RFC 3339`__ timestamp format. Example: `2019-04-03T21:10:29.600Z` __ https://tools.ietf.org/html/rfc3339 @@ -409,7 +419,7 @@ def time_of_deletion(self): def time_of_deletion(self, time_of_deletion): """ Sets the time_of_deletion of this Key. - An optional property for the deletion time of the key, expressed in `RFC 3339`__ timestamp format. + An optional property indicating when to delete the key, expressed in `RFC 3339`__ timestamp format. Example: `2019-04-03T21:10:29.600Z` __ https://tools.ietf.org/html/rfc3339 diff --git a/src/oci/key_management/models/key_shape.py b/src/oci/key_management/models/key_shape.py index a19f91d3b2..8c13e2395c 100644 --- a/src/oci/key_management/models/key_shape.py +++ b/src/oci/key_management/models/key_shape.py @@ -16,6 +16,10 @@ class KeyShape(object): #: This constant has a value of "AES" ALGORITHM_AES = "AES" + #: A constant which can be used with the algorithm property of a KeyShape. + #: This constant has a value of "RSA" + ALGORITHM_RSA = "RSA" + def __init__(self, **kwargs): """ Initializes a new KeyShape object with values from keyword arguments. @@ -23,7 +27,7 @@ def __init__(self, **kwargs): :param algorithm: The value to assign to the algorithm property of this KeyShape. - Allowed values for this property are: "AES", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "AES", "RSA", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type algorithm: str @@ -49,9 +53,9 @@ def __init__(self, **kwargs): def algorithm(self): """ **[Required]** Gets the algorithm of this KeyShape. - The algorithm used by a key's KeyVersions to encrypt or decrypt. + The algorithm used by a key's key versions to encrypt or decrypt. - Allowed values for this property are: "AES", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "AES", "RSA", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -64,13 +68,13 @@ def algorithm(self): def algorithm(self, algorithm): """ Sets the algorithm of this KeyShape. - The algorithm used by a key's KeyVersions to encrypt or decrypt. + The algorithm used by a key's key versions to encrypt or decrypt. :param algorithm: The algorithm of this KeyShape. :type: str """ - allowed_values = ["AES"] + allowed_values = ["AES", "RSA"] if not value_allowed_none_or_none_sentinel(algorithm, allowed_values): algorithm = 'UNKNOWN_ENUM_VALUE' self._algorithm = algorithm diff --git a/src/oci/key_management/models/key_summary.py b/src/oci/key_management/models/key_summary.py index 794c66dda0..c7adac42cc 100644 --- a/src/oci/key_management/models/key_summary.py +++ b/src/oci/key_management/models/key_summary.py @@ -155,8 +155,11 @@ def compartment_id(self, compartment_id): def defined_tags(self): """ Gets the defined_tags of this KeySummary. - Usage of predefined tag keys. These predefined keys are scoped to namespaces. - Example: `{\"foo-namespace\": {\"bar-key\": \"foo-value\"}}` + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :return: The defined_tags of this KeySummary. @@ -168,8 +171,11 @@ def defined_tags(self): def defined_tags(self, defined_tags): """ Sets the defined_tags of this KeySummary. - Usage of predefined tag keys. These predefined keys are scoped to namespaces. - Example: `{\"foo-namespace\": {\"bar-key\": \"foo-value\"}}` + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :param defined_tags: The defined_tags of this KeySummary. @@ -207,9 +213,11 @@ def display_name(self, display_name): def freeform_tags(self): """ Gets the freeform_tags of this KeySummary. - Simple key-value pair that is applied without any predefined name, type, or scope. - Exists for cross-compatibility only. - Example: `{\"bar-key\": \"value\"}` + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + For more information, see `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :return: The freeform_tags of this KeySummary. @@ -221,9 +229,11 @@ def freeform_tags(self): def freeform_tags(self, freeform_tags): """ Sets the freeform_tags of this KeySummary. - Simple key-value pair that is applied without any predefined name, type, or scope. - Exists for cross-compatibility only. - Example: `{\"bar-key\": \"value\"}` + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + For more information, see `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :param freeform_tags: The freeform_tags of this KeySummary. diff --git a/src/oci/key_management/models/key_version.py b/src/oci/key_management/models/key_version.py index 35ef751b18..04f2ae69ef 100644 --- a/src/oci/key_management/models/key_version.py +++ b/src/oci/key_management/models/key_version.py @@ -12,6 +12,54 @@ class KeyVersion(object): KeyVersion model. """ + #: A constant which can be used with the lifecycle_state property of a KeyVersion. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a KeyVersion. + #: This constant has a value of "ENABLING" + LIFECYCLE_STATE_ENABLING = "ENABLING" + + #: A constant which can be used with the lifecycle_state property of a KeyVersion. + #: This constant has a value of "ENABLED" + LIFECYCLE_STATE_ENABLED = "ENABLED" + + #: A constant which can be used with the lifecycle_state property of a KeyVersion. + #: This constant has a value of "DISABLING" + LIFECYCLE_STATE_DISABLING = "DISABLING" + + #: A constant which can be used with the lifecycle_state property of a KeyVersion. + #: This constant has a value of "DISABLED" + LIFECYCLE_STATE_DISABLED = "DISABLED" + + #: A constant which can be used with the lifecycle_state property of a KeyVersion. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a KeyVersion. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a KeyVersion. + #: This constant has a value of "PENDING_DELETION" + LIFECYCLE_STATE_PENDING_DELETION = "PENDING_DELETION" + + #: A constant which can be used with the lifecycle_state property of a KeyVersion. + #: This constant has a value of "SCHEDULING_DELETION" + LIFECYCLE_STATE_SCHEDULING_DELETION = "SCHEDULING_DELETION" + + #: A constant which can be used with the lifecycle_state property of a KeyVersion. + #: This constant has a value of "CANCELLING_DELETION" + LIFECYCLE_STATE_CANCELLING_DELETION = "CANCELLING_DELETION" + + #: A constant which can be used with the origin property of a KeyVersion. + #: This constant has a value of "INTERNAL" + ORIGIN_INTERNAL = "INTERNAL" + + #: A constant which can be used with the origin property of a KeyVersion. + #: This constant has a value of "EXTERNAL" + ORIGIN_EXTERNAL = "EXTERNAL" + def __init__(self, **kwargs): """ Initializes a new KeyVersion object with values from keyword arguments. @@ -29,10 +77,26 @@ def __init__(self, **kwargs): The value to assign to the key_id property of this KeyVersion. :type key_id: str + :param lifecycle_state: + The value to assign to the lifecycle_state property of this KeyVersion. + Allowed values for this property are: "CREATING", "ENABLING", "ENABLED", "DISABLING", "DISABLED", "DELETING", "DELETED", "PENDING_DELETION", "SCHEDULING_DELETION", "CANCELLING_DELETION", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param origin: + The value to assign to the origin property of this KeyVersion. + Allowed values for this property are: "INTERNAL", "EXTERNAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type origin: str + :param time_created: The value to assign to the time_created property of this KeyVersion. :type time_created: datetime + :param time_of_deletion: + The value to assign to the time_of_deletion property of this KeyVersion. + :type time_of_deletion: datetime + :param vault_id: The value to assign to the vault_id property of this KeyVersion. :type vault_id: str @@ -42,7 +106,10 @@ def __init__(self, **kwargs): 'compartment_id': 'str', 'id': 'str', 'key_id': 'str', + 'lifecycle_state': 'str', + 'origin': 'str', 'time_created': 'datetime', + 'time_of_deletion': 'datetime', 'vault_id': 'str' } @@ -50,14 +117,20 @@ def __init__(self, **kwargs): 'compartment_id': 'compartmentId', 'id': 'id', 'key_id': 'keyId', + 'lifecycle_state': 'lifecycleState', + 'origin': 'origin', 'time_created': 'timeCreated', + 'time_of_deletion': 'timeOfDeletion', 'vault_id': 'vaultId' } self._compartment_id = None self._id = None self._key_id = None + self._lifecycle_state = None + self._origin = None self._time_created = None + self._time_of_deletion = None self._vault_id = None @property @@ -132,6 +205,70 @@ def key_id(self, key_id): """ self._key_id = key_id + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this KeyVersion. + The key version's current state. + + Example: `ENABLED` + + Allowed values for this property are: "CREATING", "ENABLING", "ENABLED", "DISABLING", "DISABLED", "DELETING", "DELETED", "PENDING_DELETION", "SCHEDULING_DELETION", "CANCELLING_DELETION", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this KeyVersion. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this KeyVersion. + The key version's current state. + + Example: `ENABLED` + + + :param lifecycle_state: The lifecycle_state of this KeyVersion. + :type: str + """ + allowed_values = ["CREATING", "ENABLING", "ENABLED", "DISABLING", "DISABLED", "DELETING", "DELETED", "PENDING_DELETION", "SCHEDULING_DELETION", "CANCELLING_DELETION"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def origin(self): + """ + Gets the origin of this KeyVersion. + The source of the key material. When this value is INTERNAL, OCI KMS created the key material. When this value is EXTERNAL, the key material was imported + + Allowed values for this property are: "INTERNAL", "EXTERNAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The origin of this KeyVersion. + :rtype: str + """ + return self._origin + + @origin.setter + def origin(self, origin): + """ + Sets the origin of this KeyVersion. + The source of the key material. When this value is INTERNAL, OCI KMS created the key material. When this value is EXTERNAL, the key material was imported + + + :param origin: The origin of this KeyVersion. + :type: str + """ + allowed_values = ["INTERNAL", "EXTERNAL"] + if not value_allowed_none_or_none_sentinel(origin, allowed_values): + origin = 'UNKNOWN_ENUM_VALUE' + self._origin = origin + @property def time_created(self): """ @@ -164,6 +301,36 @@ def time_created(self, time_created): """ self._time_created = time_created + @property + def time_of_deletion(self): + """ + Gets the time_of_deletion of this KeyVersion. + An optional property indicating when to delete the key version, expressed in `RFC 3339`__ timestamp format. + Example: `2019-04-03T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_of_deletion of this KeyVersion. + :rtype: datetime + """ + return self._time_of_deletion + + @time_of_deletion.setter + def time_of_deletion(self, time_of_deletion): + """ + Sets the time_of_deletion of this KeyVersion. + An optional property indicating when to delete the key version, expressed in `RFC 3339`__ timestamp format. + Example: `2019-04-03T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_of_deletion: The time_of_deletion of this KeyVersion. + :type: datetime + """ + self._time_of_deletion = time_of_deletion + @property def vault_id(self): """ diff --git a/src/oci/key_management/models/key_version_summary.py b/src/oci/key_management/models/key_version_summary.py index cf4f676597..597617c301 100644 --- a/src/oci/key_management/models/key_version_summary.py +++ b/src/oci/key_management/models/key_version_summary.py @@ -12,6 +12,54 @@ class KeyVersionSummary(object): KeyVersionSummary model. """ + #: A constant which can be used with the lifecycle_state property of a KeyVersionSummary. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a KeyVersionSummary. + #: This constant has a value of "ENABLING" + LIFECYCLE_STATE_ENABLING = "ENABLING" + + #: A constant which can be used with the lifecycle_state property of a KeyVersionSummary. + #: This constant has a value of "ENABLED" + LIFECYCLE_STATE_ENABLED = "ENABLED" + + #: A constant which can be used with the lifecycle_state property of a KeyVersionSummary. + #: This constant has a value of "DISABLING" + LIFECYCLE_STATE_DISABLING = "DISABLING" + + #: A constant which can be used with the lifecycle_state property of a KeyVersionSummary. + #: This constant has a value of "DISABLED" + LIFECYCLE_STATE_DISABLED = "DISABLED" + + #: A constant which can be used with the lifecycle_state property of a KeyVersionSummary. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a KeyVersionSummary. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a KeyVersionSummary. + #: This constant has a value of "PENDING_DELETION" + LIFECYCLE_STATE_PENDING_DELETION = "PENDING_DELETION" + + #: A constant which can be used with the lifecycle_state property of a KeyVersionSummary. + #: This constant has a value of "SCHEDULING_DELETION" + LIFECYCLE_STATE_SCHEDULING_DELETION = "SCHEDULING_DELETION" + + #: A constant which can be used with the lifecycle_state property of a KeyVersionSummary. + #: This constant has a value of "CANCELLING_DELETION" + LIFECYCLE_STATE_CANCELLING_DELETION = "CANCELLING_DELETION" + + #: A constant which can be used with the origin property of a KeyVersionSummary. + #: This constant has a value of "INTERNAL" + ORIGIN_INTERNAL = "INTERNAL" + + #: A constant which can be used with the origin property of a KeyVersionSummary. + #: This constant has a value of "EXTERNAL" + ORIGIN_EXTERNAL = "EXTERNAL" + def __init__(self, **kwargs): """ Initializes a new KeyVersionSummary object with values from keyword arguments. @@ -29,10 +77,26 @@ def __init__(self, **kwargs): The value to assign to the key_id property of this KeyVersionSummary. :type key_id: str + :param lifecycle_state: + The value to assign to the lifecycle_state property of this KeyVersionSummary. + Allowed values for this property are: "CREATING", "ENABLING", "ENABLED", "DISABLING", "DISABLED", "DELETING", "DELETED", "PENDING_DELETION", "SCHEDULING_DELETION", "CANCELLING_DELETION", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param origin: + The value to assign to the origin property of this KeyVersionSummary. + Allowed values for this property are: "INTERNAL", "EXTERNAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type origin: str + :param time_created: The value to assign to the time_created property of this KeyVersionSummary. :type time_created: datetime + :param time_of_deletion: + The value to assign to the time_of_deletion property of this KeyVersionSummary. + :type time_of_deletion: datetime + :param vault_id: The value to assign to the vault_id property of this KeyVersionSummary. :type vault_id: str @@ -42,7 +106,10 @@ def __init__(self, **kwargs): 'compartment_id': 'str', 'id': 'str', 'key_id': 'str', + 'lifecycle_state': 'str', + 'origin': 'str', 'time_created': 'datetime', + 'time_of_deletion': 'datetime', 'vault_id': 'str' } @@ -50,14 +117,20 @@ def __init__(self, **kwargs): 'compartment_id': 'compartmentId', 'id': 'id', 'key_id': 'keyId', + 'lifecycle_state': 'lifecycleState', + 'origin': 'origin', 'time_created': 'timeCreated', + 'time_of_deletion': 'timeOfDeletion', 'vault_id': 'vaultId' } self._compartment_id = None self._id = None self._key_id = None + self._lifecycle_state = None + self._origin = None self._time_created = None + self._time_of_deletion = None self._vault_id = None @property @@ -112,7 +185,7 @@ def id(self, id): def key_id(self): """ **[Required]** Gets the key_id of this KeyVersionSummary. - The OCID of the key associated with this key version. + The OCID of the master encryption key associated with this key version. :return: The key_id of this KeyVersionSummary. @@ -124,7 +197,7 @@ def key_id(self): def key_id(self, key_id): """ Sets the key_id of this KeyVersionSummary. - The OCID of the key associated with this key version. + The OCID of the master encryption key associated with this key version. :param key_id: The key_id of this KeyVersionSummary. @@ -132,6 +205,70 @@ def key_id(self, key_id): """ self._key_id = key_id + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this KeyVersionSummary. + The key version's current state. + + Example: `ENABLED` + + Allowed values for this property are: "CREATING", "ENABLING", "ENABLED", "DISABLING", "DISABLED", "DELETING", "DELETED", "PENDING_DELETION", "SCHEDULING_DELETION", "CANCELLING_DELETION", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this KeyVersionSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this KeyVersionSummary. + The key version's current state. + + Example: `ENABLED` + + + :param lifecycle_state: The lifecycle_state of this KeyVersionSummary. + :type: str + """ + allowed_values = ["CREATING", "ENABLING", "ENABLED", "DISABLING", "DISABLED", "DELETING", "DELETED", "PENDING_DELETION", "SCHEDULING_DELETION", "CANCELLING_DELETION"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def origin(self): + """ + **[Required]** Gets the origin of this KeyVersionSummary. + The source of the key material. When this value is INTERNAL, OCI KMS created the key material. When this value is EXTERNAL, the key material was imported + + Allowed values for this property are: "INTERNAL", "EXTERNAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The origin of this KeyVersionSummary. + :rtype: str + """ + return self._origin + + @origin.setter + def origin(self, origin): + """ + Sets the origin of this KeyVersionSummary. + The source of the key material. When this value is INTERNAL, OCI KMS created the key material. When this value is EXTERNAL, the key material was imported + + + :param origin: The origin of this KeyVersionSummary. + :type: str + """ + allowed_values = ["INTERNAL", "EXTERNAL"] + if not value_allowed_none_or_none_sentinel(origin, allowed_values): + origin = 'UNKNOWN_ENUM_VALUE' + self._origin = origin + @property def time_created(self): """ @@ -164,6 +301,36 @@ def time_created(self, time_created): """ self._time_created = time_created + @property + def time_of_deletion(self): + """ + Gets the time_of_deletion of this KeyVersionSummary. + An optional property to indicate when to delete the key version, expressed in `RFC 3339`__ timestamp format. + Example: `2019-04-03T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_of_deletion of this KeyVersionSummary. + :rtype: datetime + """ + return self._time_of_deletion + + @time_of_deletion.setter + def time_of_deletion(self, time_of_deletion): + """ + Sets the time_of_deletion of this KeyVersionSummary. + An optional property to indicate when to delete the key version, expressed in `RFC 3339`__ timestamp format. + Example: `2019-04-03T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_of_deletion: The time_of_deletion of this KeyVersionSummary. + :type: datetime + """ + self._time_of_deletion = time_of_deletion + @property def vault_id(self): """ diff --git a/src/oci/key_management/models/schedule_key_deletion_details.py b/src/oci/key_management/models/schedule_key_deletion_details.py index 01bfa27e31..c44b006c11 100644 --- a/src/oci/key_management/models/schedule_key_deletion_details.py +++ b/src/oci/key_management/models/schedule_key_deletion_details.py @@ -9,7 +9,7 @@ @init_model_state_from_kwargs class ScheduleKeyDeletionDetails(object): """ - Details for scheduling key deletion + Details for scheduling key deletion. """ def __init__(self, **kwargs): @@ -36,9 +36,11 @@ def __init__(self, **kwargs): def time_of_deletion(self): """ Gets the time_of_deletion of this ScheduleKeyDeletionDetails. - An optional property to indicate the deletion time of the key, expressed in `RFC 3339`__ - timestamp format. The specified time must be between 7 and 30 days from the time - when the request is received. If this property is missing, it will be set to 30 days from the time of the request by default. + An optional property to indicate when to delete the vault, expressed in + `RFC 3339`__ timestamp format. The specified + time must be between 7 and 30 days from when the request is received. + If this property is missing, it will be set to 30 days from the time of the request + by default. __ https://tools.ietf.org/html/rfc3339 @@ -52,9 +54,11 @@ def time_of_deletion(self): def time_of_deletion(self, time_of_deletion): """ Sets the time_of_deletion of this ScheduleKeyDeletionDetails. - An optional property to indicate the deletion time of the key, expressed in `RFC 3339`__ - timestamp format. The specified time must be between 7 and 30 days from the time - when the request is received. If this property is missing, it will be set to 30 days from the time of the request by default. + An optional property to indicate when to delete the vault, expressed in + `RFC 3339`__ timestamp format. The specified + time must be between 7 and 30 days from when the request is received. + If this property is missing, it will be set to 30 days from the time of the request + by default. __ https://tools.ietf.org/html/rfc3339 diff --git a/src/oci/key_management/models/schedule_key_version_deletion_details.py b/src/oci/key_management/models/schedule_key_version_deletion_details.py new file mode 100644 index 0000000000..8838e7478f --- /dev/null +++ b/src/oci/key_management/models/schedule_key_version_deletion_details.py @@ -0,0 +1,77 @@ +# coding: utf-8 +# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ScheduleKeyVersionDeletionDetails(object): + """ + Details for scheduling key version deletion. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ScheduleKeyVersionDeletionDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param time_of_deletion: + The value to assign to the time_of_deletion property of this ScheduleKeyVersionDeletionDetails. + :type time_of_deletion: datetime + + """ + self.swagger_types = { + 'time_of_deletion': 'datetime' + } + + self.attribute_map = { + 'time_of_deletion': 'timeOfDeletion' + } + + self._time_of_deletion = None + + @property + def time_of_deletion(self): + """ + Gets the time_of_deletion of this ScheduleKeyVersionDeletionDetails. + An optional property to indicate when to delete the key version, expressed in `RFC 3339`__ + timestamp format. The specified time must be between 7 and 30 days from the time + when the request is received. If this property is missing, it will be set to 30 days from the time of the request by default. + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_of_deletion of this ScheduleKeyVersionDeletionDetails. + :rtype: datetime + """ + return self._time_of_deletion + + @time_of_deletion.setter + def time_of_deletion(self, time_of_deletion): + """ + Sets the time_of_deletion of this ScheduleKeyVersionDeletionDetails. + An optional property to indicate when to delete the key version, expressed in `RFC 3339`__ + timestamp format. The specified time must be between 7 and 30 days from the time + when the request is received. If this property is missing, it will be set to 30 days from the time of the request by default. + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_of_deletion: The time_of_deletion of this ScheduleKeyVersionDeletionDetails. + :type: datetime + """ + self._time_of_deletion = time_of_deletion + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/key_management/models/schedule_vault_deletion_details.py b/src/oci/key_management/models/schedule_vault_deletion_details.py index adc27ef92d..e269adfcde 100644 --- a/src/oci/key_management/models/schedule_vault_deletion_details.py +++ b/src/oci/key_management/models/schedule_vault_deletion_details.py @@ -9,7 +9,7 @@ @init_model_state_from_kwargs class ScheduleVaultDeletionDetails(object): """ - Details for scheduling vault deletion + Details for scheduling vault deletion. """ def __init__(self, **kwargs): @@ -36,9 +36,11 @@ def __init__(self, **kwargs): def time_of_deletion(self): """ Gets the time_of_deletion of this ScheduleVaultDeletionDetails. - An optional property to indicate the deletion time of the vault, expressed in `RFC 3339`__ - timestamp format. The specified time must be between 7 and 30 days from the time - when the request is received. If this property is missing, it will be set to 30 days from the time of the request by default. + An optional property to indicate when to delete the vault, expressed in + `RFC 3339`__ timestamp format. The specified + time must be between 7 and 30 days from the time when the request is received. + If this property is missing, it will be set to 30 days from the time of the request + by default. __ https://tools.ietf.org/html/rfc3339 @@ -52,9 +54,11 @@ def time_of_deletion(self): def time_of_deletion(self, time_of_deletion): """ Sets the time_of_deletion of this ScheduleVaultDeletionDetails. - An optional property to indicate the deletion time of the vault, expressed in `RFC 3339`__ - timestamp format. The specified time must be between 7 and 30 days from the time - when the request is received. If this property is missing, it will be set to 30 days from the time of the request by default. + An optional property to indicate when to delete the vault, expressed in + `RFC 3339`__ timestamp format. The specified + time must be between 7 and 30 days from the time when the request is received. + If this property is missing, it will be set to 30 days from the time of the request + by default. __ https://tools.ietf.org/html/rfc3339 diff --git a/src/oci/key_management/models/update_key_details.py b/src/oci/key_management/models/update_key_details.py index f4e57685c7..e0a8e22428 100644 --- a/src/oci/key_management/models/update_key_details.py +++ b/src/oci/key_management/models/update_key_details.py @@ -50,8 +50,11 @@ def __init__(self, **kwargs): def defined_tags(self): """ Gets the defined_tags of this UpdateKeyDetails. - Usage of predefined tag keys. These predefined keys are scoped to namespaces. - Example: `{\"foo-namespace\": {\"bar-key\": \"foo-value\"}}` + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :return: The defined_tags of this UpdateKeyDetails. @@ -63,8 +66,11 @@ def defined_tags(self): def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateKeyDetails. - Usage of predefined tag keys. These predefined keys are scoped to namespaces. - Example: `{\"foo-namespace\": {\"bar-key\": \"foo-value\"}}` + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :param defined_tags: The defined_tags of this UpdateKeyDetails. @@ -102,9 +108,11 @@ def display_name(self, display_name): def freeform_tags(self): """ Gets the freeform_tags of this UpdateKeyDetails. - Simple key-value pair that is applied without any predefined name, type, or scope. - Exists for cross-compatibility only. - Example: `{\"bar-key\": \"value\"}` + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + For more information, see `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :return: The freeform_tags of this UpdateKeyDetails. @@ -116,9 +124,11 @@ def freeform_tags(self): def freeform_tags(self, freeform_tags): """ Sets the freeform_tags of this UpdateKeyDetails. - Simple key-value pair that is applied without any predefined name, type, or scope. - Exists for cross-compatibility only. - Example: `{\"bar-key\": \"value\"}` + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + For more information, see `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :param freeform_tags: The freeform_tags of this UpdateKeyDetails. diff --git a/src/oci/key_management/models/update_vault_details.py b/src/oci/key_management/models/update_vault_details.py index fcefba2cba..11754f2dc6 100644 --- a/src/oci/key_management/models/update_vault_details.py +++ b/src/oci/key_management/models/update_vault_details.py @@ -50,8 +50,11 @@ def __init__(self, **kwargs): def defined_tags(self): """ Gets the defined_tags of this UpdateVaultDetails. - Usage of predefined tag keys. These predefined keys are scoped to namespaces. - Example: `{\"foo-namespace\": {\"bar-key\": \"foo-value\"}}` + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :return: The defined_tags of this UpdateVaultDetails. @@ -63,8 +66,11 @@ def defined_tags(self): def defined_tags(self, defined_tags): """ Sets the defined_tags of this UpdateVaultDetails. - Usage of predefined tag keys. These predefined keys are scoped to namespaces. - Example: `{\"foo-namespace\": {\"bar-key\": \"foo-value\"}}` + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :param defined_tags: The defined_tags of this UpdateVaultDetails. @@ -102,9 +108,11 @@ def display_name(self, display_name): def freeform_tags(self): """ Gets the freeform_tags of this UpdateVaultDetails. - Simple key-value pair that is applied without any predefined name, type, or scope. - Exists for cross-compatibility only. - Example: `{\"bar-key\": \"value\"}` + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + For more information, see `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :return: The freeform_tags of this UpdateVaultDetails. @@ -116,9 +124,11 @@ def freeform_tags(self): def freeform_tags(self, freeform_tags): """ Sets the freeform_tags of this UpdateVaultDetails. - Simple key-value pair that is applied without any predefined name, type, or scope. - Exists for cross-compatibility only. - Example: `{\"bar-key\": \"value\"}` + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + For more information, see `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :param freeform_tags: The freeform_tags of this UpdateVaultDetails. diff --git a/src/oci/key_management/models/vault.py b/src/oci/key_management/models/vault.py index 2de2c3317c..be81b3ed36 100644 --- a/src/oci/key_management/models/vault.py +++ b/src/oci/key_management/models/vault.py @@ -48,6 +48,10 @@ class Vault(object): #: This constant has a value of "VIRTUAL_PRIVATE" VAULT_TYPE_VIRTUAL_PRIVATE = "VIRTUAL_PRIVATE" + #: A constant which can be used with the vault_type property of a Vault. + #: This constant has a value of "DEFAULT" + VAULT_TYPE_DEFAULT = "DEFAULT" + def __init__(self, **kwargs): """ Initializes a new Vault object with values from keyword arguments. @@ -97,10 +101,14 @@ def __init__(self, **kwargs): :param vault_type: The value to assign to the vault_type property of this Vault. - Allowed values for this property are: "VIRTUAL_PRIVATE", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "VIRTUAL_PRIVATE", "DEFAULT", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type vault_type: str + :param wrappingkey_id: + The value to assign to the wrappingkey_id property of this Vault. + :type wrappingkey_id: str + """ self.swagger_types = { 'compartment_id': 'str', @@ -113,7 +121,8 @@ def __init__(self, **kwargs): 'management_endpoint': 'str', 'time_created': 'datetime', 'time_of_deletion': 'datetime', - 'vault_type': 'str' + 'vault_type': 'str', + 'wrappingkey_id': 'str' } self.attribute_map = { @@ -127,7 +136,8 @@ def __init__(self, **kwargs): 'management_endpoint': 'managementEndpoint', 'time_created': 'timeCreated', 'time_of_deletion': 'timeOfDeletion', - 'vault_type': 'vaultType' + 'vault_type': 'vaultType', + 'wrappingkey_id': 'wrappingkeyId' } self._compartment_id = None @@ -141,6 +151,7 @@ def __init__(self, **kwargs): self._time_created = None self._time_of_deletion = None self._vault_type = None + self._wrappingkey_id = None @property def compartment_id(self): @@ -170,7 +181,13 @@ def compartment_id(self, compartment_id): def crypto_endpoint(self): """ **[Required]** Gets the crypto_endpoint of this Vault. - The service endpoint to perform cryptographic operations against. Cryptographic operations include 'Encrypt,' 'Decrypt,' and 'GenerateDataEncryptionKey' operations. + The service endpoint to perform cryptographic operations against. Cryptographic operations include + `Encrypt`__, `Decrypt`__, + and `GenerateDataEncryptionKey`__ operations. + + __ https://docs.cloud.oracle.com/api/#/en/key/release/EncryptedData/Encrypt + __ https://docs.cloud.oracle.com/api/#/en/key/release/DecryptedData/Decrypt + __ https://docs.cloud.oracle.com/api/#/en/key/release/GeneratedKey/GenerateDataEncryptionKey :return: The crypto_endpoint of this Vault. @@ -182,7 +199,13 @@ def crypto_endpoint(self): def crypto_endpoint(self, crypto_endpoint): """ Sets the crypto_endpoint of this Vault. - The service endpoint to perform cryptographic operations against. Cryptographic operations include 'Encrypt,' 'Decrypt,' and 'GenerateDataEncryptionKey' operations. + The service endpoint to perform cryptographic operations against. Cryptographic operations include + `Encrypt`__, `Decrypt`__, + and `GenerateDataEncryptionKey`__ operations. + + __ https://docs.cloud.oracle.com/api/#/en/key/release/EncryptedData/Encrypt + __ https://docs.cloud.oracle.com/api/#/en/key/release/DecryptedData/Decrypt + __ https://docs.cloud.oracle.com/api/#/en/key/release/GeneratedKey/GenerateDataEncryptionKey :param crypto_endpoint: The crypto_endpoint of this Vault. @@ -194,8 +217,11 @@ def crypto_endpoint(self, crypto_endpoint): def defined_tags(self): """ Gets the defined_tags of this Vault. - Usage of predefined tag keys. These predefined keys are scoped to namespaces. - Example: `{\"foo-namespace\": {\"bar-key\": \"foo-value\"}}` + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :return: The defined_tags of this Vault. @@ -207,8 +233,11 @@ def defined_tags(self): def defined_tags(self, defined_tags): """ Sets the defined_tags of this Vault. - Usage of predefined tag keys. These predefined keys are scoped to namespaces. - Example: `{\"foo-namespace\": {\"bar-key\": \"foo-value\"}}` + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :param defined_tags: The defined_tags of this Vault. @@ -246,9 +275,11 @@ def display_name(self, display_name): def freeform_tags(self): """ Gets the freeform_tags of this Vault. - Simple key-value pair that is applied without any predefined name, type, or scope. - Exists for cross-compatibility only. - Example: `{\"bar-key\": \"value\"}` + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + For more information, see `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :return: The freeform_tags of this Vault. @@ -260,9 +291,11 @@ def freeform_tags(self): def freeform_tags(self, freeform_tags): """ Sets the freeform_tags of this Vault. - Simple key-value pair that is applied without any predefined name, type, or scope. - Exists for cross-compatibility only. - Example: `{\"bar-key\": \"value\"}` + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + For more information, see `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :param freeform_tags: The freeform_tags of this Vault. @@ -332,7 +365,7 @@ def lifecycle_state(self, lifecycle_state): def management_endpoint(self): """ **[Required]** Gets the management_endpoint of this Vault. - The service endpoint to perform management operations against. Management operations include 'Create,' 'Update,' 'List,' 'Get,' and 'Delete' operations. + The service endpoint to perform management operations against. Management operations include \"Create,\" \"Update,\" \"List,\" \"Get,\" and \"Delete\" operations. :return: The management_endpoint of this Vault. @@ -344,7 +377,7 @@ def management_endpoint(self): def management_endpoint(self, management_endpoint): """ Sets the management_endpoint of this Vault. - The service endpoint to perform management operations against. Management operations include 'Create,' 'Update,' 'List,' 'Get,' and 'Delete' operations. + The service endpoint to perform management operations against. Management operations include \"Create,\" \"Update,\" \"List,\" \"Get,\" and \"Delete\" operations. :param management_endpoint: The management_endpoint of this Vault. @@ -388,7 +421,7 @@ def time_created(self, time_created): def time_of_deletion(self): """ Gets the time_of_deletion of this Vault. - An optional property for the deletion time of the vault, expressed in `RFC 3339`__ timestamp format. + An optional property to indicate when to delete the vault, expressed in `RFC 3339`__ timestamp format. Example: `2018-04-03T21:10:29.600Z` __ https://tools.ietf.org/html/rfc3339 @@ -403,7 +436,7 @@ def time_of_deletion(self): def time_of_deletion(self, time_of_deletion): """ Sets the time_of_deletion of this Vault. - An optional property for the deletion time of the vault, expressed in `RFC 3339`__ timestamp format. + An optional property to indicate when to delete the vault, expressed in `RFC 3339`__ timestamp format. Example: `2018-04-03T21:10:29.600Z` __ https://tools.ietf.org/html/rfc3339 @@ -418,9 +451,10 @@ def time_of_deletion(self, time_of_deletion): def vault_type(self): """ **[Required]** Gets the vault_type of this Vault. - The type of vault. Each type of vault stores the key with different degrees of isolation and has different options and pricing. + The type of vault. Each type of vault stores the key with different + degrees of isolation and has different options and pricing. - Allowed values for this property are: "VIRTUAL_PRIVATE", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "VIRTUAL_PRIVATE", "DEFAULT", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -433,17 +467,42 @@ def vault_type(self): def vault_type(self, vault_type): """ Sets the vault_type of this Vault. - The type of vault. Each type of vault stores the key with different degrees of isolation and has different options and pricing. + The type of vault. Each type of vault stores the key with different + degrees of isolation and has different options and pricing. :param vault_type: The vault_type of this Vault. :type: str """ - allowed_values = ["VIRTUAL_PRIVATE"] + allowed_values = ["VIRTUAL_PRIVATE", "DEFAULT"] if not value_allowed_none_or_none_sentinel(vault_type, allowed_values): vault_type = 'UNKNOWN_ENUM_VALUE' self._vault_type = vault_type + @property + def wrappingkey_id(self): + """ + **[Required]** Gets the wrappingkey_id of this Vault. + The OCID of the vault wrapping key. + + + :return: The wrappingkey_id of this Vault. + :rtype: str + """ + return self._wrappingkey_id + + @wrappingkey_id.setter + def wrappingkey_id(self, wrappingkey_id): + """ + Sets the wrappingkey_id of this Vault. + The OCID of the vault wrapping key. + + + :param wrappingkey_id: The wrappingkey_id of this Vault. + :type: str + """ + self._wrappingkey_id = wrappingkey_id + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/key_management/models/vault_summary.py b/src/oci/key_management/models/vault_summary.py index ed420814d4..8807726da3 100644 --- a/src/oci/key_management/models/vault_summary.py +++ b/src/oci/key_management/models/vault_summary.py @@ -48,6 +48,10 @@ class VaultSummary(object): #: This constant has a value of "VIRTUAL_PRIVATE" VAULT_TYPE_VIRTUAL_PRIVATE = "VIRTUAL_PRIVATE" + #: A constant which can be used with the vault_type property of a VaultSummary. + #: This constant has a value of "DEFAULT" + VAULT_TYPE_DEFAULT = "DEFAULT" + def __init__(self, **kwargs): """ Initializes a new VaultSummary object with values from keyword arguments. @@ -93,7 +97,7 @@ def __init__(self, **kwargs): :param vault_type: The value to assign to the vault_type property of this VaultSummary. - Allowed values for this property are: "VIRTUAL_PRIVATE", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "VIRTUAL_PRIVATE", "DEFAULT", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type vault_type: str @@ -163,7 +167,13 @@ def compartment_id(self, compartment_id): def crypto_endpoint(self): """ **[Required]** Gets the crypto_endpoint of this VaultSummary. - The service endpoint to perform cryptographic operations against. Cryptographic operations include 'Encrypt,' 'Decrypt,' and 'GenerateDataEncryptionKey' operations. + The service endpoint to perform cryptographic operations against. Cryptographic operations include + `Encrypt`__, `Decrypt`__, + and `GenerateDataEncryptionKey`__ operations. + + __ https://docs.cloud.oracle.com/api/#/en/key/release/EncryptedData/Encrypt + __ https://docs.cloud.oracle.com/api/#/en/key/release/DecryptedData/Decrypt + __ https://docs.cloud.oracle.com/api/#/en/key/release/GeneratedKey/GenerateDataEncryptionKey :return: The crypto_endpoint of this VaultSummary. @@ -175,7 +185,13 @@ def crypto_endpoint(self): def crypto_endpoint(self, crypto_endpoint): """ Sets the crypto_endpoint of this VaultSummary. - The service endpoint to perform cryptographic operations against. Cryptographic operations include 'Encrypt,' 'Decrypt,' and 'GenerateDataEncryptionKey' operations. + The service endpoint to perform cryptographic operations against. Cryptographic operations include + `Encrypt`__, `Decrypt`__, + and `GenerateDataEncryptionKey`__ operations. + + __ https://docs.cloud.oracle.com/api/#/en/key/release/EncryptedData/Encrypt + __ https://docs.cloud.oracle.com/api/#/en/key/release/DecryptedData/Decrypt + __ https://docs.cloud.oracle.com/api/#/en/key/release/GeneratedKey/GenerateDataEncryptionKey :param crypto_endpoint: The crypto_endpoint of this VaultSummary. @@ -187,8 +203,11 @@ def crypto_endpoint(self, crypto_endpoint): def defined_tags(self): """ Gets the defined_tags of this VaultSummary. - Usage of predefined tag keys. These predefined keys are scoped to namespaces. - Example: `{\"foo-namespace\": {\"bar-key\": \"foo-value\"}}` + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :return: The defined_tags of this VaultSummary. @@ -200,8 +219,11 @@ def defined_tags(self): def defined_tags(self, defined_tags): """ Sets the defined_tags of this VaultSummary. - Usage of predefined tag keys. These predefined keys are scoped to namespaces. - Example: `{\"foo-namespace\": {\"bar-key\": \"foo-value\"}}` + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :param defined_tags: The defined_tags of this VaultSummary. @@ -239,9 +261,11 @@ def display_name(self, display_name): def freeform_tags(self): """ Gets the freeform_tags of this VaultSummary. - Simple key-value pair that is applied without any predefined name, type, or scope. - Exists for cross-compatibility only. - Example: `{\"bar-key\": \"value\"}` + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + For more information, see `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :return: The freeform_tags of this VaultSummary. @@ -253,9 +277,11 @@ def freeform_tags(self): def freeform_tags(self, freeform_tags): """ Sets the freeform_tags of this VaultSummary. - Simple key-value pair that is applied without any predefined name, type, or scope. - Exists for cross-compatibility only. - Example: `{\"bar-key\": \"value\"}` + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + For more information, see `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :param freeform_tags: The freeform_tags of this VaultSummary. @@ -325,7 +351,7 @@ def lifecycle_state(self, lifecycle_state): def management_endpoint(self): """ **[Required]** Gets the management_endpoint of this VaultSummary. - The service endpoint to perform management operations against. Management operations include 'Create,' 'Update,' 'List,' 'Get,' and 'Delete' operations. + The service endpoint to perform management operations against. Management operations include \"Create,\" \"Update,\" \"List,\" \"Get,\" and \"Delete\" operations. :return: The management_endpoint of this VaultSummary. @@ -337,7 +363,7 @@ def management_endpoint(self): def management_endpoint(self, management_endpoint): """ Sets the management_endpoint of this VaultSummary. - The service endpoint to perform management operations against. Management operations include 'Create,' 'Update,' 'List,' 'Get,' and 'Delete' operations. + The service endpoint to perform management operations against. Management operations include \"Create,\" \"Update,\" \"List,\" \"Get,\" and \"Delete\" operations. :param management_endpoint: The management_endpoint of this VaultSummary. @@ -381,9 +407,10 @@ def time_created(self, time_created): def vault_type(self): """ **[Required]** Gets the vault_type of this VaultSummary. - The type of vault. Each type of vault stores keys with different degrees of isolation and has different options and pricing. + The type of vault. Each type of vault stores keys with different + degrees of isolation and has different options and pricing. - Allowed values for this property are: "VIRTUAL_PRIVATE", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "VIRTUAL_PRIVATE", "DEFAULT", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -396,13 +423,14 @@ def vault_type(self): def vault_type(self, vault_type): """ Sets the vault_type of this VaultSummary. - The type of vault. Each type of vault stores keys with different degrees of isolation and has different options and pricing. + The type of vault. Each type of vault stores keys with different + degrees of isolation and has different options and pricing. :param vault_type: The vault_type of this VaultSummary. :type: str """ - allowed_values = ["VIRTUAL_PRIVATE"] + allowed_values = ["VIRTUAL_PRIVATE", "DEFAULT"] if not value_allowed_none_or_none_sentinel(vault_type, allowed_values): vault_type = 'UNKNOWN_ENUM_VALUE' self._vault_type = vault_type diff --git a/src/oci/key_management/models/wrapped_import_key.py b/src/oci/key_management/models/wrapped_import_key.py new file mode 100644 index 0000000000..eade0440a0 --- /dev/null +++ b/src/oci/key_management/models/wrapped_import_key.py @@ -0,0 +1,113 @@ +# coding: utf-8 +# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class WrappedImportKey(object): + """ + WrappedImportKey model. + """ + + #: A constant which can be used with the wrapping_algorithm property of a WrappedImportKey. + #: This constant has a value of "RSA_OAEP_SHA256" + WRAPPING_ALGORITHM_RSA_OAEP_SHA256 = "RSA_OAEP_SHA256" + + def __init__(self, **kwargs): + """ + Initializes a new WrappedImportKey object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param key_material: + The value to assign to the key_material property of this WrappedImportKey. + :type key_material: str + + :param wrapping_algorithm: + The value to assign to the wrapping_algorithm property of this WrappedImportKey. + Allowed values for this property are: "RSA_OAEP_SHA256" + :type wrapping_algorithm: str + + """ + self.swagger_types = { + 'key_material': 'str', + 'wrapping_algorithm': 'str' + } + + self.attribute_map = { + 'key_material': 'keyMaterial', + 'wrapping_algorithm': 'wrappingAlgorithm' + } + + self._key_material = None + self._wrapping_algorithm = None + + @property + def key_material(self): + """ + **[Required]** Gets the key_material of this WrappedImportKey. + The wrapped/encrypted key material to import. It is encrypted using RSA wrapped key and Base64 encoded. + + + :return: The key_material of this WrappedImportKey. + :rtype: str + """ + return self._key_material + + @key_material.setter + def key_material(self, key_material): + """ + Sets the key_material of this WrappedImportKey. + The wrapped/encrypted key material to import. It is encrypted using RSA wrapped key and Base64 encoded. + + + :param key_material: The key_material of this WrappedImportKey. + :type: str + """ + self._key_material = key_material + + @property + def wrapping_algorithm(self): + """ + **[Required]** Gets the wrapping_algorithm of this WrappedImportKey. + The wrapping mechanism to be used during key import + + Allowed values for this property are: "RSA_OAEP_SHA256" + + + :return: The wrapping_algorithm of this WrappedImportKey. + :rtype: str + """ + return self._wrapping_algorithm + + @wrapping_algorithm.setter + def wrapping_algorithm(self, wrapping_algorithm): + """ + Sets the wrapping_algorithm of this WrappedImportKey. + The wrapping mechanism to be used during key import + + + :param wrapping_algorithm: The wrapping_algorithm of this WrappedImportKey. + :type: str + """ + allowed_values = ["RSA_OAEP_SHA256"] + if not value_allowed_none_or_none_sentinel(wrapping_algorithm, allowed_values): + raise ValueError( + "Invalid value for `wrapping_algorithm`, must be None or one of {0}" + .format(allowed_values) + ) + self._wrapping_algorithm = wrapping_algorithm + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/key_management/models/wrapping_key.py b/src/oci/key_management/models/wrapping_key.py new file mode 100644 index 0000000000..f051703262 --- /dev/null +++ b/src/oci/key_management/models/wrapping_key.py @@ -0,0 +1,260 @@ +# coding: utf-8 +# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class WrappingKey(object): + """ + WrappingKey model. + """ + + #: A constant which can be used with the lifecycle_state property of a WrappingKey. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a WrappingKey. + #: This constant has a value of "ENABLED" + LIFECYCLE_STATE_ENABLED = "ENABLED" + + #: A constant which can be used with the lifecycle_state property of a WrappingKey. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a WrappingKey. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + def __init__(self, **kwargs): + """ + Initializes a new WrappingKey object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param compartment_id: + The value to assign to the compartment_id property of this WrappingKey. + :type compartment_id: str + + :param id: + The value to assign to the id property of this WrappingKey. + :type id: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this WrappingKey. + Allowed values for this property are: "CREATING", "ENABLED", "DELETING", "DELETED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param public_key: + The value to assign to the public_key property of this WrappingKey. + :type public_key: str + + :param time_created: + The value to assign to the time_created property of this WrappingKey. + :type time_created: datetime + + :param vault_id: + The value to assign to the vault_id property of this WrappingKey. + :type vault_id: str + + """ + self.swagger_types = { + 'compartment_id': 'str', + 'id': 'str', + 'lifecycle_state': 'str', + 'public_key': 'str', + 'time_created': 'datetime', + 'vault_id': 'str' + } + + self.attribute_map = { + 'compartment_id': 'compartmentId', + 'id': 'id', + 'lifecycle_state': 'lifecycleState', + 'public_key': 'publicKey', + 'time_created': 'timeCreated', + 'vault_id': 'vaultId' + } + + self._compartment_id = None + self._id = None + self._lifecycle_state = None + self._public_key = None + self._time_created = None + self._vault_id = None + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this WrappingKey. + The OCID of the compartment that contains this key. + + + :return: The compartment_id of this WrappingKey. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this WrappingKey. + The OCID of the compartment that contains this key. + + + :param compartment_id: The compartment_id of this WrappingKey. + :type: str + """ + self._compartment_id = compartment_id + + @property + def id(self): + """ + **[Required]** Gets the id of this WrappingKey. + The OCID of the key. + + + :return: The id of this WrappingKey. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this WrappingKey. + The OCID of the key. + + + :param id: The id of this WrappingKey. + :type: str + """ + self._id = id + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this WrappingKey. + The key's current state. + + Example: `ENABLED` + + Allowed values for this property are: "CREATING", "ENABLED", "DELETING", "DELETED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this WrappingKey. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this WrappingKey. + The key's current state. + + Example: `ENABLED` + + + :param lifecycle_state: The lifecycle_state of this WrappingKey. + :type: str + """ + allowed_values = ["CREATING", "ENABLED", "DELETING", "DELETED"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def public_key(self): + """ + **[Required]** Gets the public_key of this WrappingKey. + The public key in PEM format to encrypt the key material before importing it with ImportKey/ImportKeyVersion. + + + :return: The public_key of this WrappingKey. + :rtype: str + """ + return self._public_key + + @public_key.setter + def public_key(self, public_key): + """ + Sets the public_key of this WrappingKey. + The public key in PEM format to encrypt the key material before importing it with ImportKey/ImportKeyVersion. + + + :param public_key: The public_key of this WrappingKey. + :type: str + """ + self._public_key = public_key + + @property + def time_created(self): + """ + **[Required]** Gets the time_created of this WrappingKey. + The date and time the key was created, expressed in `RFC 3339`__ timestamp format. + + Example: `2018-04-03T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_created of this WrappingKey. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this WrappingKey. + The date and time the key was created, expressed in `RFC 3339`__ timestamp format. + + Example: `2018-04-03T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_created: The time_created of this WrappingKey. + :type: datetime + """ + self._time_created = time_created + + @property + def vault_id(self): + """ + **[Required]** Gets the vault_id of this WrappingKey. + The OCID of the vault that contains this key. + + + :return: The vault_id of this WrappingKey. + :rtype: str + """ + return self._vault_id + + @vault_id.setter + def vault_id(self, vault_id): + """ + Sets the vault_id of this WrappingKey. + The OCID of the vault that contains this key. + + + :param vault_id: The vault_id of this WrappingKey. + :type: str + """ + self._vault_id = vault_id + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/oce/models/__init__.py b/src/oci/oce/models/__init__.py index c9861afd09..dd84b4d20b 100644 --- a/src/oci/oce/models/__init__.py +++ b/src/oci/oce/models/__init__.py @@ -5,7 +5,7 @@ from .change_oce_instance_compartment_details import ChangeOceInstanceCompartmentDetails from .create_oce_instance_details import CreateOceInstanceDetails -from .delete_oce_instance_details import DeleteOceInstanceDetails +from .identity_stripe_details import IdentityStripeDetails from .oce_instance import OceInstance from .oce_instance_summary import OceInstanceSummary from .update_oce_instance_details import UpdateOceInstanceDetails @@ -20,7 +20,7 @@ oce_type_mapping = { "ChangeOceInstanceCompartmentDetails": ChangeOceInstanceCompartmentDetails, "CreateOceInstanceDetails": CreateOceInstanceDetails, - "DeleteOceInstanceDetails": DeleteOceInstanceDetails, + "IdentityStripeDetails": IdentityStripeDetails, "OceInstance": OceInstance, "OceInstanceSummary": OceInstanceSummary, "UpdateOceInstanceDetails": UpdateOceInstanceDetails, diff --git a/src/oci/oce/models/create_oce_instance_details.py b/src/oci/oce/models/create_oce_instance_details.py index 19335163e7..ac33c9f8cd 100644 --- a/src/oci/oce/models/create_oce_instance_details.py +++ b/src/oci/oce/models/create_oce_instance_details.py @@ -37,6 +37,10 @@ def __init__(self, **kwargs): The value to assign to the idcs_access_token property of this CreateOceInstanceDetails. :type idcs_access_token: str + :param identity_stripe: + The value to assign to the identity_stripe property of this CreateOceInstanceDetails. + :type identity_stripe: IdentityStripeDetails + :param tenancy_name: The value to assign to the tenancy_name property of this CreateOceInstanceDetails. :type tenancy_name: str @@ -64,6 +68,7 @@ def __init__(self, **kwargs): 'name': 'str', 'tenancy_id': 'str', 'idcs_access_token': 'str', + 'identity_stripe': 'IdentityStripeDetails', 'tenancy_name': 'str', 'object_storage_namespace': 'str', 'admin_email': 'str', @@ -77,6 +82,7 @@ def __init__(self, **kwargs): 'name': 'name', 'tenancy_id': 'tenancyId', 'idcs_access_token': 'idcsAccessToken', + 'identity_stripe': 'identityStripe', 'tenancy_name': 'tenancyName', 'object_storage_namespace': 'objectStorageNamespace', 'admin_email': 'adminEmail', @@ -89,6 +95,7 @@ def __init__(self, **kwargs): self._name = None self._tenancy_id = None self._idcs_access_token = None + self._identity_stripe = None self._tenancy_name = None self._object_storage_namespace = None self._admin_email = None @@ -215,6 +222,26 @@ def idcs_access_token(self, idcs_access_token): """ self._idcs_access_token = idcs_access_token + @property + def identity_stripe(self): + """ + Gets the identity_stripe of this CreateOceInstanceDetails. + + :return: The identity_stripe of this CreateOceInstanceDetails. + :rtype: IdentityStripeDetails + """ + return self._identity_stripe + + @identity_stripe.setter + def identity_stripe(self, identity_stripe): + """ + Sets the identity_stripe of this CreateOceInstanceDetails. + + :param identity_stripe: The identity_stripe of this CreateOceInstanceDetails. + :type: IdentityStripeDetails + """ + self._identity_stripe = identity_stripe + @property def tenancy_name(self): """ diff --git a/src/oci/oce/models/identity_stripe_details.py b/src/oci/oce/models/identity_stripe_details.py new file mode 100644 index 0000000000..34c556d918 --- /dev/null +++ b/src/oci/oce/models/identity_stripe_details.py @@ -0,0 +1,104 @@ +# coding: utf-8 +# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class IdentityStripeDetails(object): + """ + Identity Stripe + """ + + def __init__(self, **kwargs): + """ + Initializes a new IdentityStripeDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param service_name: + The value to assign to the service_name property of this IdentityStripeDetails. + :type service_name: str + + :param tenancy: + The value to assign to the tenancy property of this IdentityStripeDetails. + :type tenancy: str + + """ + self.swagger_types = { + 'service_name': 'str', + 'tenancy': 'str' + } + + self.attribute_map = { + 'service_name': 'serviceName', + 'tenancy': 'tenancy' + } + + self._service_name = None + self._tenancy = None + + @property + def service_name(self): + """ + **[Required]** Gets the service_name of this IdentityStripeDetails. + Name of the Identity Cloud Service instance in My Services to be used. + Example: `secondstripe` + + + :return: The service_name of this IdentityStripeDetails. + :rtype: str + """ + return self._service_name + + @service_name.setter + def service_name(self, service_name): + """ + Sets the service_name of this IdentityStripeDetails. + Name of the Identity Cloud Service instance in My Services to be used. + Example: `secondstripe` + + + :param service_name: The service_name of this IdentityStripeDetails. + :type: str + """ + self._service_name = service_name + + @property + def tenancy(self): + """ + **[Required]** Gets the tenancy of this IdentityStripeDetails. + Value of the Identity Cloud Service tenancy. + Example: `idcs-8416ebdd0d674f84803f4193cce026e9` + + + :return: The tenancy of this IdentityStripeDetails. + :rtype: str + """ + return self._tenancy + + @tenancy.setter + def tenancy(self, tenancy): + """ + Sets the tenancy of this IdentityStripeDetails. + Value of the Identity Cloud Service tenancy. + Example: `idcs-8416ebdd0d674f84803f4193cce026e9` + + + :param tenancy: The tenancy of this IdentityStripeDetails. + :type: str + """ + self._tenancy = tenancy + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/oce/models/oce_instance.py b/src/oci/oce/models/oce_instance.py index 83590cea62..259fb8b05e 100644 --- a/src/oci/oce/models/oce_instance.py +++ b/src/oci/oce/models/oce_instance.py @@ -73,6 +73,10 @@ def __init__(self, **kwargs): The value to assign to the tenancy_name property of this OceInstance. :type tenancy_name: str + :param identity_stripe: + The value to assign to the identity_stripe property of this OceInstance. + :type identity_stripe: IdentityStripeDetails + :param object_storage_namespace: The value to assign to the object_storage_namespace property of this OceInstance. :type object_storage_namespace: str @@ -121,6 +125,7 @@ def __init__(self, **kwargs): 'tenancy_id': 'str', 'idcs_tenancy': 'str', 'tenancy_name': 'str', + 'identity_stripe': 'IdentityStripeDetails', 'object_storage_namespace': 'str', 'admin_email': 'str', 'time_created': 'datetime', @@ -141,6 +146,7 @@ def __init__(self, **kwargs): 'tenancy_id': 'tenancyId', 'idcs_tenancy': 'idcsTenancy', 'tenancy_name': 'tenancyName', + 'identity_stripe': 'identityStripe', 'object_storage_namespace': 'objectStorageNamespace', 'admin_email': 'adminEmail', 'time_created': 'timeCreated', @@ -160,6 +166,7 @@ def __init__(self, **kwargs): self._tenancy_id = None self._idcs_tenancy = None self._tenancy_name = None + self._identity_stripe = None self._object_storage_namespace = None self._admin_email = None self._time_created = None @@ -362,6 +369,26 @@ def tenancy_name(self, tenancy_name): """ self._tenancy_name = tenancy_name + @property + def identity_stripe(self): + """ + Gets the identity_stripe of this OceInstance. + + :return: The identity_stripe of this OceInstance. + :rtype: IdentityStripeDetails + """ + return self._identity_stripe + + @identity_stripe.setter + def identity_stripe(self, identity_stripe): + """ + Sets the identity_stripe of this OceInstance. + + :param identity_stripe: The identity_stripe of this OceInstance. + :type: IdentityStripeDetails + """ + self._identity_stripe = identity_stripe + @property def object_storage_namespace(self): """ diff --git a/src/oci/oce/oce_instance_client.py b/src/oci/oce/oce_instance_client.py index 38a83bf438..4b8a2248af 100644 --- a/src/oci/oce/oce_instance_client.py +++ b/src/oci/oce/oce_instance_client.py @@ -248,7 +248,7 @@ def create_oce_instance(self, create_oce_instance_details, **kwargs): header_params=header_params, body=create_oce_instance_details) - def delete_oce_instance(self, oce_instance_id, delete_oce_instance_details, **kwargs): + def delete_oce_instance(self, oce_instance_id, **kwargs): """ Delete a provisioned OceInstance Deletes a OceInstance resource by identifier @@ -257,9 +257,6 @@ def delete_oce_instance(self, oce_instance_id, delete_oce_instance_details, **kw :param str oce_instance_id: (required) unique OceInstance identifier - :param DeleteOceInstanceDetails delete_oce_instance_details: (required) - The information about resource to be deleted. - :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the @@ -323,15 +320,13 @@ def delete_oce_instance(self, oce_instance_id, delete_oce_instance_details, **kw resource_path=resource_path, method=method, path_params=path_params, - header_params=header_params, - body=delete_oce_instance_details) + header_params=header_params) else: return self.base_client.call_api( resource_path=resource_path, method=method, path_params=path_params, - header_params=header_params, - body=delete_oce_instance_details) + header_params=header_params) def get_oce_instance(self, oce_instance_id, **kwargs): """ diff --git a/src/oci/oce/oce_instance_client_composite_operations.py b/src/oci/oce/oce_instance_client_composite_operations.py index 04f4f40a34..ce960839a0 100644 --- a/src/oci/oce/oce_instance_client_composite_operations.py +++ b/src/oci/oce/oce_instance_client_composite_operations.py @@ -101,7 +101,7 @@ def create_oce_instance_and_wait_for_state(self, create_oce_instance_details, wa except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) - def delete_oce_instance_and_wait_for_state(self, oce_instance_id, delete_oce_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + def delete_oce_instance_and_wait_for_state(self, oce_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.oce.OceInstanceClient.delete_oce_instance` and waits for the :py:class:`~oci.oce.models.WorkRequest` to enter the given state(s). @@ -109,9 +109,6 @@ def delete_oce_instance_and_wait_for_state(self, oce_instance_id, delete_oce_ins :param str oce_instance_id: (required) unique OceInstance identifier - :param DeleteOceInstanceDetails delete_oce_instance_details: (required) - The information about resource to be deleted. - :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.oce.models.WorkRequest.status` @@ -124,7 +121,7 @@ def delete_oce_instance_and_wait_for_state(self, oce_instance_id, delete_oce_ins """ operation_result = None try: - operation_result = self.client.delete_oce_instance(oce_instance_id, delete_oce_instance_details, **operation_kwargs) + operation_result = self.client.delete_oce_instance(oce_instance_id, **operation_kwargs) except oci.exceptions.ServiceError as e: if e.status == 404: return WAIT_RESOURCE_NOT_FOUND diff --git a/src/oci/streaming/models/connect_harness.py b/src/oci/streaming/models/connect_harness.py index f4118db8d0..117dea4e1b 100644 --- a/src/oci/streaming/models/connect_harness.py +++ b/src/oci/streaming/models/connect_harness.py @@ -32,6 +32,10 @@ class ConnectHarness(object): #: This constant has a value of "FAILED" LIFECYCLE_STATE_FAILED = "FAILED" + #: A constant which can be used with the lifecycle_state property of a ConnectHarness. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + def __init__(self, **kwargs): """ Initializes a new ConnectHarness object with values from keyword arguments. @@ -51,7 +55,7 @@ def __init__(self, **kwargs): :param lifecycle_state: The value to assign to the lifecycle_state property of this ConnectHarness. - Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "UPDATING", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_state: str @@ -185,7 +189,7 @@ def lifecycle_state(self): **[Required]** Gets the lifecycle_state of this ConnectHarness. The current state of the connect harness. - Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "UPDATING", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -204,7 +208,7 @@ def lifecycle_state(self, lifecycle_state): :param lifecycle_state: The lifecycle_state of this ConnectHarness. :type: str """ - allowed_values = ["CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED"] + allowed_values = ["CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "UPDATING"] if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._lifecycle_state = lifecycle_state diff --git a/src/oci/streaming/models/connect_harness_summary.py b/src/oci/streaming/models/connect_harness_summary.py index b2f451f20c..53b7a7abee 100644 --- a/src/oci/streaming/models/connect_harness_summary.py +++ b/src/oci/streaming/models/connect_harness_summary.py @@ -32,6 +32,10 @@ class ConnectHarnessSummary(object): #: This constant has a value of "FAILED" LIFECYCLE_STATE_FAILED = "FAILED" + #: A constant which can be used with the lifecycle_state property of a ConnectHarnessSummary. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + def __init__(self, **kwargs): """ Initializes a new ConnectHarnessSummary object with values from keyword arguments. @@ -51,7 +55,7 @@ def __init__(self, **kwargs): :param lifecycle_state: The value to assign to the lifecycle_state property of this ConnectHarnessSummary. - Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "UPDATING", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_state: str @@ -178,7 +182,7 @@ def lifecycle_state(self): **[Required]** Gets the lifecycle_state of this ConnectHarnessSummary. The current state of the connect harness. - Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "UPDATING", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -197,7 +201,7 @@ def lifecycle_state(self, lifecycle_state): :param lifecycle_state: The lifecycle_state of this ConnectHarnessSummary. :type: str """ - allowed_values = ["CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED"] + allowed_values = ["CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "UPDATING"] if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._lifecycle_state = lifecycle_state diff --git a/src/oci/streaming/models/update_stream_pool_details.py b/src/oci/streaming/models/update_stream_pool_details.py index 96ab5dea7c..b24ec4af07 100644 --- a/src/oci/streaming/models/update_stream_pool_details.py +++ b/src/oci/streaming/models/update_stream_pool_details.py @@ -17,6 +17,10 @@ def __init__(self, **kwargs): Initializes a new UpdateStreamPoolDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class): + :param name: + The value to assign to the name property of this UpdateStreamPoolDetails. + :type name: str + :param kafka_settings: The value to assign to the kafka_settings property of this UpdateStreamPoolDetails. :type kafka_settings: KafkaSettings @@ -31,21 +35,44 @@ def __init__(self, **kwargs): """ self.swagger_types = { + 'name': 'str', 'kafka_settings': 'KafkaSettings', 'freeform_tags': 'dict(str, str)', 'defined_tags': 'dict(str, dict(str, object))' } self.attribute_map = { + 'name': 'name', 'kafka_settings': 'kafkaSettings', 'freeform_tags': 'freeformTags', 'defined_tags': 'definedTags' } + self._name = None self._kafka_settings = None self._freeform_tags = None self._defined_tags = None + @property + def name(self): + """ + Gets the name of this UpdateStreamPoolDetails. + + :return: The name of this UpdateStreamPoolDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this UpdateStreamPoolDetails. + + :param name: The name of this UpdateStreamPoolDetails. + :type: str + """ + self._name = name + @property def kafka_settings(self): """ diff --git a/src/oci/streaming/stream_admin_client.py b/src/oci/streaming/stream_admin_client.py index 92f3ddde64..924ee85310 100644 --- a/src/oci/streaming/stream_admin_client.py +++ b/src/oci/streaming/stream_admin_client.py @@ -1199,7 +1199,7 @@ def list_connect_harnesses(self, compartment_id, **kwargs): :param str lifecycle_state: (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. - Allowed values are: "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED" + Allowed values are: "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "UPDATING" :param str opc_request_id: (optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a @@ -1251,7 +1251,7 @@ def list_connect_harnesses(self, compartment_id, **kwargs): ) if 'lifecycle_state' in kwargs: - lifecycle_state_allowed_values = ["CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED"] + lifecycle_state_allowed_values = ["CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "UPDATING"] if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: raise ValueError( "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) @@ -1296,13 +1296,13 @@ def list_connect_harnesses(self, compartment_id, **kwargs): header_params=header_params, response_type="list[ConnectHarnessSummary]") - def list_stream_pools(self, **kwargs): + def list_stream_pools(self, compartment_id, **kwargs): """ List the stream pools for a given compartment ID. List the stream pools for a given compartment ID. - :param str compartment_id: (optional) + :param str compartment_id: (required) The OCID of the compartment. :param str id: (optional) @@ -1353,7 +1353,6 @@ def list_stream_pools(self, **kwargs): # Don't accept unknown kwargs expected_kwargs = [ "retry_strategy", - "compartment_id", "id", "name", "limit", @@ -1390,7 +1389,7 @@ def list_stream_pools(self, **kwargs): ) query_params = { - "compartmentId": kwargs.get("compartment_id", missing), + "compartmentId": compartment_id, "id": kwargs.get("id", missing), "name": kwargs.get("name", missing), "limit": kwargs.get("limit", missing), @@ -1428,7 +1427,7 @@ def list_stream_pools(self, **kwargs): header_params=header_params, response_type="list[StreamPoolSummary]") - def list_streams(self, compartment_id, **kwargs): + def list_streams(self, **kwargs): """ Lists the streams in the given compartment id. Lists the streams in the given compartment id. @@ -1437,11 +1436,11 @@ def list_streams(self, compartment_id, **kwargs): The compartment id and stream pool id cannot be specified at the same time. - :param str compartment_id: (required) - The OCID of the compartment. + :param str compartment_id: (optional) + The OCID of the compartment. Is exclusive with the `streamPoolId` parameter. One of them is required. :param str stream_pool_id: (optional) - The OCID of the stream pool. + The OCID of the stream pool. Is exclusive with the `compartmentId` parameter. One of them is required. :param str id: (optional) A filter to return only resources that match the given ID exactly. @@ -1491,6 +1490,7 @@ def list_streams(self, compartment_id, **kwargs): # Don't accept unknown kwargs expected_kwargs = [ "retry_strategy", + "compartment_id", "stream_pool_id", "id", "name", @@ -1528,7 +1528,7 @@ def list_streams(self, compartment_id, **kwargs): ) query_params = { - "compartmentId": compartment_id, + "compartmentId": kwargs.get("compartment_id", missing), "streamPoolId": kwargs.get("stream_pool_id", missing), "id": kwargs.get("id", missing), "name": kwargs.get("name", missing), diff --git a/src/oci/version.py b/src/oci/version.py index 3a6cfa32ca..23861e0ae9 100644 --- a/src/oci/version.py +++ b/src/oci/version.py @@ -1,4 +1,4 @@ # coding: utf-8 # Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. -__version__ = "2.7.1" +__version__ = "2.8.0"